---
title: "Validate And Verify Service Connector Config"
method: POST
path: "/api/v1/service_connectors/verify"
tags: ["service_connectors"]
---

# Validate And Verify Service Connector Config

`POST /api/v1/service_connectors/verify`

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.

## Query parameters

- `list_resources` boolean

## Request body

- ServiceConnectorRequest — Request model for service connectors.
  - `user` string, uuid, required
  - `workspace` string, uuid, required
  - `name` string, required
  - `connector_type` union, required
    - string
    - ServiceConnectorTypeModel — 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).
      - `name` string, required
      - `connector_type` string, required
      - `description` string
      - `resource_types` ResourceTypeModel[], required
        - `name` string, required
        - `resource_type` string, required
        - `description` string
        - `auth_methods` string[], required
        - `supports_instances` boolean
        - `logo_url` string, nullable
        - `emoji` string, nullable
      - `auth_methods` AuthenticationMethodModel[], required
        - `name` string, required
        - `auth_method` string, required
        - `description` string
        - `config_schema` object
        - `min_expiration_seconds` integer, nullable
        - `max_expiration_seconds` integer, nullable
        - `default_expiration_seconds` integer, nullable
      - `supports_auto_configuration` boolean
      - `logo_url` string, nullable
      - `emoji` string, nullable
      - `docs_url` string, nullable
      - `sdk_docs_url` string, nullable
      - `local` boolean
      - `remote` boolean
  - `description` string
  - `auth_method` string, required
  - `resource_types` string[]
  - `resource_id` string, nullable
  - `supports_instances` boolean
  - `expires_at` string, date-time, nullable
  - `expires_skew_tolerance` integer, nullable
  - `expiration_seconds` integer, nullable
  - `configuration` object
  - `secrets` object
  - `labels` object

## Response `200`

Successful Response

- ServiceConnectorResourcesModel — Service connector resources list. Lists the resource types and resource instances that a service connector can provide access to.
  - `id` string, uuid, nullable
  - `name` string, nullable
  - `connector_type` union, required
    - string
    - ServiceConnectorTypeModel — 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).
      - `name` string, required
      - `connector_type` string, required
      - `description` string
      - `resource_types` ResourceTypeModel[], required
        - `name` string, required
        - `resource_type` string, required
        - `description` string
        - `auth_methods` string[], required
        - `supports_instances` boolean
        - `logo_url` string, nullable
        - `emoji` string, nullable
      - `auth_methods` AuthenticationMethodModel[], required
        - `name` string, required
        - `auth_method` string, required
        - `description` string
        - `config_schema` object
        - `min_expiration_seconds` integer, nullable
        - `max_expiration_seconds` integer, nullable
        - `default_expiration_seconds` integer, nullable
      - `supports_auto_configuration` boolean
      - `logo_url` string, nullable
      - `emoji` string, nullable
      - `docs_url` string, nullable
      - `sdk_docs_url` string, nullable
      - `local` boolean
      - `remote` boolean
  - `resources` ServiceConnectorTypedResourcesModel[]
    - `resource_type` string, required
    - `resource_ids` string[], nullable
    - `error` string, nullable
  - `error` string, nullable

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `409` — Conflict
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/zenml-io/apis/zenml-2.md) · [All operations](https://skmtc.net/zenml-io/apis/zenml-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenml-io/zenml-2/versions/febb01b8bce3/schema)