Verify

Validate And Verify Service Connector Config

post

Verifies if a service connector configuration has access to resources.

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

Args: connector: The service connector configuration to verify. list_resources: If True, the list of all resources accessible through the service connector is returned.

Returns: The list of resources that the service connector configuration has access to.

Authorizations

Query parameters

list_resourcesbooleanOptionalDefault: true

Body

Request model for service connectors.

userany ofOptional

namestring · max: 255Required

connector_typeany ofRequired

Service connector type specification.

Describes the types of resources to which the service connector can be used to gain access and the authentication methods that are supported by the service connector.

The connector type, resource types, resource IDs and authentication methods can all be used as search criteria to lookup and filter service connector instances that are compatible with the requirements of a consumer (e.g. a stack component).

descriptionstringOptionalDefault: ""

auth_methodstring · max: 255Required

resource_typesstring[]Optional

resource_idany ofOptional

supports_instancesbooleanOptionalDefault: false

expires_atany ofOptional

expires_skew_toleranceany ofOptional

expiration_secondsany ofOptional

configurationobjectOptional

secretsobjectOptional

labelsobjectOptional

Responses

application/json

objectOptional

Service connector resources list.

Lists the resource types and resource instances that a service connector can provide access to.

application/json

application/json

application/json

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/service_connectors/verify HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 438

{
  "user": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "connector_type": "text",
  "description": "text",
  "auth_method": "text",
  "resource_types": [
    "text"
  ],
  "resource_id": "text",
  "supports_instances": true,
  "expires_at": "2025-04-21T16:49:05.607Z",
  "expires_skew_tolerance": 1,
  "expiration_seconds": 1,
  "configuration": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "secrets": {
    "ANY_ADDITIONAL_PROPERTY": "password"
  },
  "labels": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "connector_type": "text",
  "resources": [
    {
      "resource_type": "text",
      "resource_ids": [
        "text"
      ],
      "error": "text"
    }
  ],
  "error": "text"
}

Validate And Verify Service Connector

put

Verifies if a service connector instance has access to one or more resources.

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: The ID of the service connector to verify. resource_type: The type of resource to verify access to. resource_id: The ID of the resource to verify access to. list_resources: If True, the list of all resources accessible through the service connector and matching the supplied resource type and ID are returned.

Returns: The list of resources that the service connector has access to, scoped to the supplied resource type and ID, if provided.

Authorizations

Path parameters

connector_idstring · uuidRequired

Query parameters

resource_typeany ofOptional

resource_idany ofOptional

list_resourcesbooleanOptionalDefault: true

Responses

application/json

objectOptional

Service connector resources list.

Lists the resource types and resource instances that a service connector can provide access to.

application/json

application/json

application/json

application/json

put

HTTPcURLJavaScriptPython

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "connector_type": "text",
  "resources": [
    {
      "resource_type": "text",
      "resource_ids": [
        "text"
      ],
      "error": "text"
    }
  ],
  "error": "text"
}