Integrations

Update an integration

Changed on

Partially update an integration. type is immutable (and, for LLM, config.provider). At least one field must be provided.

Payload Requirements

  • type is required (it selects the per-type PATCH shape) and is immutable: it must match the stored integration's type, otherwise the request is rejected with 422 (change category by delete + recreate).
  • At least one updatable field (name, description, scopings, config) must be provided in addition to type.
  • Scalar fields deep-merge: omit = keep, explicit null = clear (for nullable fields).
  • Collection fields (scopings, config.headers) replace the existing values when provided.
  • For type: EVALUATOR, config.headers accepts a string map (replace), null (clear), or may be omitted (keep).
  • type: EVALUATOR requires the remote evaluators feature to be enabled.

Valid example (type: EVALUATOR)

{
  "type": "EVALUATOR",
  "config": {
    "endpoint": "https://eval.example.com/v2/evaluate"
  }
}

Invalid example (type mismatch)

{
  "type": "AGENT"
}

<Warning>This endpoint is in alpha, read more here.</Warning>

patch/v2/integrations/{integration_id}

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/integrations/{integration_id}
  • Auth
    HTTP bearer

Path parameters

integration_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique integration identifier.

Request body

OR
OR

Response

An integration object.

OR
OR

Changes

  • 00294ff0845aRevision changes
    • breaking

      removed from the ///// request property oneOf list

    • breaking

      the ///// request property type changed from object to no type

    • breaking

      added to the //// response property oneOf list for the response status

    • info

      removed discriminator from ///// request property

    • info

      added the new TOGETHER_AI enum value to the request property /////

    • info

      added to the ///// request property oneOf list

    • info

      added TOGETHER_AI discriminator mapping keys to the //// response property for the response status

    • info

      added the required property ///////// to the response with the status

  • 4755281baae4Revision changes
    • breaking

      the request's body type changed from object to no type