Client

Get Service Connector Client

get

Get a service connector client for a service connector and given resource.

This requires the service connector implementation to be installed on the ZenML server, otherwise a 501 Not Implemented error will be returned.

Args: connector_id: ID of the service connector. resource_type: Type of the resource to list. resource_id: ID of the resource to list.

Returns: A service connector client that can be used to access the given resource.

Authorizations

Path parameters

connector_idstring · uuidrequired

Query parameters

resource_typeany ofoptional

resource_idany ofoptional

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v1/service_connectors/{connector_id}/client'

200

401

403

404

422

200

{
  "body": {
    "created": "2025-03-28T17:41:25.424Z",
    "updated": "2025-03-28T17:41:25.424Z",
    "user": {
      "body": {
        "created": "2025-03-28T17:41:25.424Z",
        "updated": "2025-03-28T17:41:25.424Z",
        "active": true,
        "activation_token": "text",
        "full_name": "text",
        "email_opted_in": true,
        "is_service_account": true,
        "is_admin": true
      },
      "metadata": {
        "email": "text",
        "external_user_id": "123e4567-e89b-12d3-a456-426614174000",
        "user_metadata": {}
      },
      "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-03-28T17:41:25.424Z",
    "expires_skew_tolerance": 1
  },
  "metadata": {
    "configuration": {},
    "secret_id": "123e4567-e89b-12d3-a456-426614174000",
    "expiration_seconds": 1,
    "secrets": {
      "ANY_ADDITIONAL_PROPERTY": "password"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "permission_denied": true,
  "name": "text"
}

Successful Response