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

Query parameters

project_name_or_idany ofOptional

stringOptional

or

string · uuidOptional

or

nullOptional

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 ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

createdany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

updatedany ofOptional

string · date-timeOptional

or

stringOptional

or

nullOptional

scope_userany ofOptional

string · uuidOptional

or

nullOptional

userany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

nameany ofOptional

stringOptional

or

nullOptional

connector_typeany ofOptional

stringOptional

or

nullOptional

auth_methodany ofOptional

stringOptional

or

nullOptional

resource_typeany ofOptional

stringOptional

or

nullOptional

resource_idany ofOptional

stringOptional

or

nullOptional

labels_strany ofOptional

stringOptional

or

nullOptional

secret_idany ofOptional

string · uuidOptional

or

stringOptional

or

nullOptional

Body

any ofOptional

or

nullOptional

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/service_connectors HTTP/1.1
Host: 
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": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "user": {
          "body": {
            "created": "2025-04-26T17:46:46.324Z",
            "updated": "2025-04-26T17:46:46.324Z",
            "active": true,
            "activation_token": "text",
            "full_name": "text",
            "email_opted_in": true,
            "is_service_account": true,
            "is_admin": true,
            "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
          },
          "metadata": {
            "email": "text",
            "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": true,
          "name": "text"
        },
        "description": "text",
        "connector_type": "text",
        "auth_method": "text",
        "resource_types": [
          "text"
        ],
        "resource_id": "text",
        "supports_instances": true,
        "expires_at": "2025-04-26T17:46:46.324Z",
        "expires_skew_tolerance": 1
      },
      "metadata": {
        "configuration": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "secret_id": "123e4567-e89b-12d3-a456-426614174000",
        "expiration_seconds": 1,
        "secrets": {},
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "resources": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "permission_denied": true,
      "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

Path parameters

connector_idstring · uuidRequired

Query parameters

expand_secretsbooleanOptionalDefault: true

hydratebooleanOptionalDefault: true

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/service_connectors/{connector_id} HTTP/1.1
Host: 
Accept: */*

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "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": true,
      "name": "text"
    },
    "description": "text",
    "connector_type": "text",
    "auth_method": "text",
    "resource_types": [
      "text"
    ],
    "resource_id": "text",
    "supports_instances": true,
    "expires_at": "2025-04-26T17:46:46.324Z",
    "expires_skew_tolerance": 1
  },
  "metadata": {
    "configuration": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "secret_id": "123e4567-e89b-12d3-a456-426614174000",
    "expiration_seconds": 1,
    "secrets": {},
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "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

Path parameters

connector_idstring · uuidRequired

Body

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 and secrets fields together represent a full valid configuration update, not just a partial update. If either is set (i.e. not None) in the update, their values are merged together and will replace the existing configuration and secrets 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.

nameany ofOptional

string · max: 255Optional

or

nullOptional

connector_typeany ofOptional

stringOptional

or

or

nullOptional

descriptionany ofOptional

stringOptional

or

nullOptional

auth_methodany ofOptional

string · max: 255Optional

or

nullOptional

resource_typesany ofOptional

string[]Optional

or

nullOptional

resource_idany ofOptional

string · max: 255Optional

or

nullOptional

supports_instancesany ofOptional

booleanOptional

or

nullOptional

expires_atany ofOptional

string · date-timeOptional

or

nullOptional

expires_skew_toleranceany ofOptional

integerOptional

or

nullOptional

expiration_secondsany ofOptional

integerOptional

or

nullOptional

configurationany ofOptional

or

nullOptional

secretsany ofOptional

or

nullOptional

labelsany ofOptional

or

nullOptional

Responses

put

HTTPcURLJavaScriptPython

PUT /api/v1/service_connectors/{connector_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 392

{
  "name": "text",
  "connector_type": "text",
  "description": "text",
  "auth_method": "text",
  "resource_types": [
    "text"
  ],
  "resource_id": "text",
  "supports_instances": true,
  "expires_at": "2025-04-26T17:46:46.324Z",
  "expires_skew_tolerance": 1,
  "expiration_seconds": 1,
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "secrets": {
    "ANY_ADDITIONAL_PROPERTY": "password"
  },
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "body": {
    "created": "2025-04-26T17:46:46.324Z",
    "updated": "2025-04-26T17:46:46.324Z",
    "user": {
      "body": {
        "created": "2025-04-26T17:46:46.324Z",
        "updated": "2025-04-26T17:46:46.324Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true,
        "default_project_id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "metadata": {
        "email": "text",
        "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": true,
      "name": "text"
    },
    "description": "text",
    "connector_type": "text",
    "auth_method": "text",
    "resource_types": [
      "text"
    ],
    "resource_id": "text",
    "supports_instances": true,
    "expires_at": "2025-04-26T17:46:46.324Z",
    "expires_skew_tolerance": 1
  },
  "metadata": {
    "configuration": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "secret_id": "123e4567-e89b-12d3-a456-426614174000",
    "expiration_seconds": 1,
    "secrets": {},
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Delete Service Connector

delete

Deletes a service connector.

Args: connector_id: ID of the service connector.

Authorizations

Path parameters

connector_idstring · uuidRequired

Responses

Responseany

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/service_connectors/{connector_id} HTTP/1.1
Host: 
Accept: */*

No content