Service connectors

List Service Connectors

get

Get a list of all service connectors.

Args: connector_filter_model: Filter model used for pagination, sorting, filtering project_name_or_id: Optional name or ID of the project to filter by. expand_secrets: Whether to expand secrets or not. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: Page with list of service connectors matching the filter criteria.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Query parameters

project_name_or_idany of · nullableOptional

stringOptional

or

string · uuidOptional

expand_secretsbooleanOptionalDefault: true

hydratebooleanOptionalDefault: false

sort_bystringOptionalDefault: created

logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:

pageinteger · min: 1OptionalDefault: 1

sizeinteger · min: 1 · max: 10000OptionalDefault: 20

idany of · nullableOptional

string · uuidOptional

or

stringOptional

or

createdany of · nullableOptional

string · date-timeOptional

or

stringOptional

or

updatedany of · nullableOptional

string · date-timeOptional

or

stringOptional

or

scope_userstring · uuid · nullableOptional

userany of · nullableOptional

string · uuidOptional

or

stringOptional

or

nameany of · nullableOptional

stringOptional

or

string[]Optional

connector_typeany of · nullableOptional

stringOptional

or

string[]Optional

auth_methodany of · nullableOptional

stringOptional

or

string[]Optional

resource_typestring · nullableOptional

resource_idstring · nullableOptional

labels_strstring · nullableOptional

Body

application/json

Other propertiesstring · nullableOptional

Responses

200

Successful Response

application/json

indexintegerRequired

max_sizeintegerRequired

total_pagesintegerRequired

totalintegerRequired

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get/api/v1/service_connectors

HTTPcURLJavaScriptPython

GET /api/v1/service_connectors HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

{
  "index": 1,
  "max_size": 1,
  "total_pages": 1,
  "total": 1,
  "items": [
    {
      "body": {
        "created": "2026-07-19T11:31:32.591Z",
        "updated": "2026-07-19T11:31:32.591Z",
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "description": "",
        "connector_type": "text",
        "auth_method": "text",
        "resource_types": [
          "text"
        ],
        "resource_id": "text",
        "supports_instances": false,
        "expires_at": "2026-07-19T11:31:32.591Z",
        "expires_skew_tolerance": 1
      },
      "metadata": {
        "configuration": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "expiration_seconds": 1,
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "resources": {
        "user": {
          "body": {
            "created": "2026-07-19T11:31:32.591Z",
            "updated": "2026-07-19T11:31:32.591Z",
            "active": false,
            "activation_token": "text",
            "full_name": "",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
            "avatar_url": "text"
          },
          "metadata": {
            "email": "",
            "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
            "user_metadata": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "resources": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "permission_denied": false,
          "name": "text"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    }
  ]
}

Get Service Connector

get

Returns the requested service connector.

Args: connector_id: ID of the service connector. expand_secrets: Whether to expand secrets or not. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The requested service connector.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Path parameters

connector_idstring · uuidRequired

Query parameters

expand_secretsbooleanOptionalDefault: true

hydratebooleanOptionalDefault: true

Responses

200

Successful Response

application/json

Response model for service connectors.

idstring · uuidRequired

permission_deniedbooleanOptionalDefault: false

namestring · max: 255Required

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

get/api/v1/service_connectors/{connector_id}

HTTPcURLJavaScriptPython

GET /api/v1/service_connectors/{connector_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "body": {
    "created": "2026-07-19T11:31:32.591Z",
    "updated": "2026-07-19T11:31:32.591Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "",
    "connector_type": "text",
    "auth_method": "text",
    "resource_types": [
      "text"
    ],
    "resource_id": "text",
    "supports_instances": false,
    "expires_at": "2026-07-19T11:31:32.591Z",
    "expires_skew_tolerance": 1
  },
  "metadata": {
    "configuration": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "expiration_seconds": 1,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "user": {
      "body": {
        "created": "2026-07-19T11:31:32.591Z",
        "updated": "2026-07-19T11:31:32.591Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}

Update Service Connector

put

Updates a service connector.

Args: connector_id: ID of the service connector. connector_update: Service connector to use to update.

Returns: Updated service connector.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Path parameters

connector_idstring · uuidRequired

Body

application/json

Model used for service connector updates.

Most fields in the update model are optional and will not be updated if omitted. However, the following fields are "special" and leaving them out will also cause the corresponding value to be removed from the service connector in the database:

• the resource_id field
• the expiration_seconds field

In addition to the above exceptions, the following rules apply:

• the configuration field represents a full valid configuration update, not just a partial update. If it is set (i.e. not None) in the update, its values will replace the existing configuration values.
• the labels field is also a full labels update: if set (i.e. not None), all existing labels are removed and replaced by the new labels in the update.

NOTE: the attributes here override the ones in the base class, so they have a None default value.

namestring · max: 255 · nullableOptional

connector_typeany of · nullableOptional

stringOptional

or

descriptionstring · nullableOptional

auth_methodstring · max: 255 · nullableOptional

resource_typesstring[] · nullableOptional

resource_idstring · max: 255 · nullableOptional

supports_instancesboolean · nullableOptional

expires_atstring · date-time · nullableOptional

expires_skew_toleranceinteger · nullableOptional

expiration_secondsinteger · nullableOptional

Responses

200

Successful Response

application/json

Response model for service connectors.

idstring · uuidRequired

permission_deniedbooleanOptionalDefault: false

namestring · max: 255Required

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

put/api/v1/service_connectors/{connector_id}

HTTPcURLJavaScriptPython

PUT /api/v1/service_connectors/{connector_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "name": "text",
  "connector_type": "text",
  "description": "text",
  "auth_method": "text",
  "resource_types": [
    "text"
  ],
  "resource_id": "text",
  "supports_instances": true,
  "expires_at": "2026-07-19T11:31:32.591Z",
  "expires_skew_tolerance": 1,
  "expiration_seconds": 1,
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "body": {
    "created": "2026-07-19T11:31:32.591Z",
    "updated": "2026-07-19T11:31:32.591Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "description": "",
    "connector_type": "text",
    "auth_method": "text",
    "resource_types": [
      "text"
    ],
    "resource_id": "text",
    "supports_instances": false,
    "expires_at": "2026-07-19T11:31:32.591Z",
    "expires_skew_tolerance": 1
  },
  "metadata": {
    "configuration": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "expiration_seconds": 1,
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "user": {
      "body": {
        "created": "2026-07-19T11:31:32.591Z",
        "updated": "2026-07-19T11:31:32.591Z",
        "active": false,
        "activation_token": "text",
        "full_name": "",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000",
        "avatar_url": "text"
      },
      "metadata": {
        "email": "",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": false,
      "name": "text"
    },
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": false,
  "name": "text"
}

Delete Service Connector

delete

Deletes a service connector.

Args: connector_id: ID of the service connector.

Authorizations

CookieOAuth2TokenBearer

OAuth2passwordRequired

Token URL:

Path parameters

connector_idstring · uuidRequired

Responses

200

Successful Response

application/json

anyOptional

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

delete/api/v1/service_connectors/{connector_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/service_connectors/{connector_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content