---
title: "Get a connector as form data"
method: GET
path: "/api/v1/connectors/{connector_id}/form"
tags: ["Connectors"]
---

# Get a connector as form data

`GET /api/v1/connectors/{connector_id}/form`

## Request

- Base URL: `https://pcp.example.com`
- URL: `https://pcp.example.com/api/v1/connectors/{connector_id}/form`
- Auth: HTTP bearer

Answers the connector's configuration document with its protocol's form schema. Keys the schema does not show are left out.

## Path parameters

- `connector_id` string, required

## Query parameters

- `organization_id` string, uuid

## Response `200`

OK

- ConnectorFormResponse: ConnectorFormResponse schema
  - `access` object
    - `can_author` boolean
    - `can_delete` boolean
    - `can_execute` boolean
    - `can_view` boolean
  - `configuration` object
  - `created_at` string, date-time
  - `data_classes` string[], nullable
  - `endpoints` object[]
    - `endpoint` string
  - `environment` string, nullable
  - `id` string, uuid
  - `integration` object
    - `created_at` string, date-time
    - `fields` object, nullable
    - `id` string, uuid
    - `name` string, nullable
    - `protocols` string[], nullable
    - `supports` string[], nullable
    - `updated_at` string, date-time
    - `version` string, nullable
  - `inventory` object, nullable
    - `access` object
      - `can_author` boolean
      - `can_delete` boolean
      - `can_execute` boolean
      - `can_view` boolean
    - `aws_configuration` object
      - `access_key` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `credentials_type` string
      - `region` string
      - `secret_access_key` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
    - `coverage` object
      - `excluded` integer
      - `protected` integer
      - `unprotected` integer
    - `gcp_configuration` object
      - `gcp_project_id` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `gcp_service_account_json` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
    - `id` string, uuid
    - `k8s_configuration` object
      - `k8s_filter_namespaces` string
      - `k8s_kubeconf` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
    - `last_update` string, date-time
    - `name` string
    - `openshift_configuration` object
      - `openshift_filter_namespaces` string
      - `openshift_kubeconf` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
    - `openstack_configuration` object
      - `openstack_application_credential_id` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `openstack_application_credential_secret` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `openstack_auth_url` string
      - `openstack_domain_name` string
      - `openstack_password` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `openstack_project_id` string
      - `openstack_project_name` string
      - `openstack_region` string
      - `openstack_username` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
    - `ovh_configuration` object
      - `application_key` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `application_secret` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `consumer_key` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `endpoint` string
    - `residency` string, nullable
    - `scaleway_configuration` object
      - `scw_access_key` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `scw_project_id` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `scw_secret_key` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
    - `summaries` object[]
      - `class` string
      - `count` integer
      - `name` string
    - `type` string
    - `vmware_configuration` object
      - `vsphere_password` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `vsphere_server` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `vsphere_tls_ca_bundle` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
      - `vsphere_tls_skip_verify` string
      - `vsphere_username` object
        - `provider` object, nullable
          - `id` string, uuid
        - `value` string
  - `last_check` string, date-time, nullable
  - `name` string
  - `protocol` string
  - `resource` object, nullable
    - `class` string
    - `configured_connectors` object[]
      - `country_detected` string, nullable
      - `id` string, uuid
      - `integration` object
        - `created_at` string, date-time
        - `fields` object, nullable
        - `id` string, uuid
        - `name` string, nullable
        - `protocols` string[], nullable
        - `supports` string[], nullable
        - `updated_at` string, date-time
        - `version` string, nullable
      - `name` string
      - `residency` string, nullable
      - `type` string
    - `country_detected` string, nullable
    - `coverage_status` string
    - `excluded_from_coverage` boolean
    - `id` string, uuid
    - `inventory_id` string, uuid
    - `inventory_name` string
    - `inventory_type` string
    - `locked` boolean
    - `name` string
    - `residency` string, nullable
    - `service` string
    - `subclass` string
    - `tags` string[]
    - `urn` string
    - `urn_id` string, uuid
  - `revision` integer
  - `root` string
  - `schema` object
    - `bundle_fields` object, nullable
    - `initial` object
    - `schema` object
    - `scheme` string
  - `temperature` string, nullable
  - `type` string
  - `updated_at` string, date-time

## Other responses

- `400`: Bad Request _(validation or deserialization error)_
- `401`: Missing, invalid or expired credentials
- `403`: The caller may not do this
- `500`: Internal Server Error _(panics)_
- `default`

---

[API](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1.md) - [All operations](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/plakar/apis/plakar-control-plane-api-v1/revisions/2ac049494a01?raw)