Connectors

Stores, sources and destinations.

12 endpoints · Plakar Control Plane v0.19 · Base URL, authentication and errors

List the connectors

GET /api/v1/account/organizations/{id}/connectors

Badge

Path parameters

id string<uuid> required

Organization ID, at or below the caller’s.

Query parameters

type string required

Connector kind.

Allowed: source, destination, store
offset integer

Number of items to skip.

Default: 0
limit integer

Maximum number of items to return.

Default: 50 Min: 1 Max: 50
search string

Free-text search on connectors.
residency string

Only connectors in this country.
inventory_id string<uuid>

Only connectors of this inventory.
without_residency boolean

Only connectors without a residency. Not combinable with residency.

Default: false
exclude_locked boolean

Exclude locked connectors.

Default: false

Response 200 OK application/json

items array[object]
- access object
  
  can_author boolean
  
  can_delete boolean
  
  can_execute boolean
  
  can_view boolean
- created_at string<date-time>
- data_classes array[string] nullable
- endpoints array[object]
  
  endpoint string
- environment string nullable
- fields map[object]
  
  filtered boolean nullable
  
  provider object nullable
  
  id string<uuid>
  
  value string
- id string<uuid>
- integration object
  
  created_at string<date-time>
  
  fields map[array[object]] nullable
  
  id string<uuid>
  
  name string nullable
  
  protocols array[string] nullable
  
  supports array[string] nullable
  
  updated_at string<date-time>
  
  version string nullable
- inventory object nullable
  
  id string<uuid>
  
  name string
  
  residency string nullable
  
  type string
- last_check string<date-time> nullable
- name string
- protocol string
- resource object nullable
  
  class string
  
  configured_connectors array[object]
  
  country_detected string nullable
  
  id string<uuid>
  
  integration object
  
  created_at string<date-time>
  
  fields map[array[object]] nullable
  
  id string<uuid>
  
  name string nullable
  
  protocols array[string] nullable
  
  supports array[string] nullable
  
  updated_at string<date-time>
  
  version string nullable
  
  name string
  
  residency string nullable
  
  type string
  
  country_detected string nullable
  
  coverage_status string
  
  edge_pool_id string<uuid>
  
  effective_edge_pool_id string<uuid>
  
  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 array[string]
  
  urn string
  
  urn_id string<uuid>
- revision integer
- root string
- temperature string nullable
- type string
- updated_at string<date-time>
total integer

Errors

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)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/account/organizations/{id}/connectors' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "items": [
    {
      "access": {
        "can_author": true,
        "can_delete": true,
        "can_execute": true,
        "can_view": true
      },
      "created_at": "2026-01-01T00:00:00Z",
      "data_classes": [
        "string"
      ],
      "endpoints": [
        {
          "endpoint": "string"
        }
      ],
      "environment": "string",
      "fields": {
        "key": {
          "filtered": true,
          "provider": {
            "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
          },
          "value": "string"
        }
      },
      "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
      "integration": {
        "created_at": "2026-01-01T00:00:00Z",
        "fields": {
          "key": [
            {
              "default": "string",
              "description": "string",
              "display_name": "string",
              "enum": [
                "string"
              ],
              "inventory_value": "string",
              "name": "string",
              "pattern": "string",
              "required": true,
              "sensitive": true,
              "type": "string"
            }
          ]
        },
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "name": "string",
        "protocols": [
          "string"
        ],
        "supports": [
          "string"
        ],
        "updated_at": "2026-01-01T00:00:00Z",
        "version": "string"
      },
      "inventory": {
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "name": "string",
        "residency": "string",
        "type": "string"
      },
      "last_check": "2026-01-01T00:00:00Z",
      "name": "string",
      "protocol": "string",
      "resource": {
        "class": "string",
        "configured_connectors": [
          {
            "country_detected": "string",
            "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
            "integration": {
              "created_at": "2026-01-01T00:00:00Z",
              "fields": {
                "key": [
                  {
                    "default": "string",
                    "description": "string",
                    "display_name": "string",
                    "enum": [
                      "string"
                    ],
                    "inventory_value": "string",
                    "name": "string",
                    "pattern": "string",
                    "required": true,
                    "sensitive": true,
                    "type": "string"
                  }
                ]
              },
              "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
              "name": "string",
              "protocols": [
                "string"
              ],
              "supports": [
                "string"
              ],
              "updated_at": "2026-01-01T00:00:00Z",
              "version": "string"
            },
            "name": "string",
            "residency": "string",
            "type": "string"
          }
        ],
        "country_detected": "string",
        "coverage_status": "string",
        "edge_pool_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "effective_edge_pool_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "excluded_from_coverage": true,
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "inventory_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "inventory_name": "string",
        "inventory_type": "string",
        "locked": true,
        "name": "string",
        "residency": "string",
        "service": "string",
        "subclass": "string",
        "tags": [
          "string"
        ],
        "urn": "string",
        "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
      },
      "revision": 0,
      "root": "string",
      "temperature": "string",
      "type": "string",
      "updated_at": "2026-01-01T00:00:00Z"
    }
  ],
  "total": 0
}

Create a connector

POST /api/v1/account/organizations/{id}/connectors

Badge

Path parameters

id string<uuid> required

Organization ID, at or below the caller’s.

Request body application/json required

data_classes array[string]
endpoints array[object]
- endpoint string
environment string
fields map[object] required
- filtered boolean nullable
- provider object nullable
  
  id string<uuid>
- value string
integration object
- created_at string<date-time>
- fields map[array[object]] nullable
- id string<uuid>
- name string nullable
- protocols array[string] nullable
- supports array[string] nullable
- updated_at string<date-time>
- version string nullable
name string required
protocol string required
temperature string nullable
type string required
urn_id string<uuid>

Response 200 OK application/json

data_classes array[string] nullable
endpoints array[object]
- endpoint string
environment string nullable
fields map[object]
- filtered boolean nullable
- provider object nullable
  
  id string<uuid>
- value string
id string<uuid>
integration object
- created_at string<date-time>
- fields map[array[object]] nullable
- id string<uuid>
- name string nullable
- protocols array[string] nullable
- supports array[string] nullable
- updated_at string<date-time>
- version string nullable
last_check string<date-time> nullable
name string
protocol string
temperature string nullable
type string
urn_id string<uuid>

Errors

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)

Every error returns the standard error body.

Request

curl -X POST 'https://pcp.example.com/api/v1/account/organizations/{id}/connectors' \
  -H 'Authorization: Bearer <badge>' \
  -H 'Content-Type: application/json' \
  -d '{
  "data_classes": [
    "string"
  ],
  "endpoints": [
    {
      "endpoint": "string"
    }
  ],
  "environment": "string",
  "fields": {
    "key": {
      "filtered": true,
      "provider": {
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
      },
      "value": "string"
    }
  },
  "integration": {
    "created_at": "2026-01-01T00:00:00Z",
    "fields": {
      "key": [
        {
          "default": "string",
          "description": "string",
          "display_name": "string",
          "enum": [
            "string"
          ],
          "inventory_value": "string",
          "name": "string",
          "pattern": "string",
          "required": true,
          "sensitive": true,
          "type": "string"
        }
      ]
    },
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "name": "string",
    "protocols": [
      "string"
    ],
    "supports": [
      "string"
    ],
    "updated_at": "2026-01-01T00:00:00Z",
    "version": "string"
  },
  "name": "string",
  "protocol": "string",
  "temperature": "string",
  "type": "string",
  "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
}'

Response 200

{
  "data_classes": [
    "string"
  ],
  "endpoints": [
    {
      "endpoint": "string"
    }
  ],
  "environment": "string",
  "fields": {
    "key": {
      "filtered": true,
      "provider": {
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
      },
      "value": "string"
    }
  },
  "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
  "integration": {
    "created_at": "2026-01-01T00:00:00Z",
    "fields": {
      "key": [
        {
          "default": "string",
          "description": "string",
          "display_name": "string",
          "enum": [
            "string"
          ],
          "inventory_value": "string",
          "name": "string",
          "pattern": "string",
          "required": true,
          "sensitive": true,
          "type": "string"
        }
      ]
    },
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "name": "string",
    "protocols": [
      "string"
    ],
    "supports": [
      "string"
    ],
    "updated_at": "2026-01-01T00:00:00Z",
    "version": "string"
  },
  "last_check": "2026-01-01T00:00:00Z",
  "name": "string",
  "protocol": "string",
  "temperature": "string",
  "type": "string",
  "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
}

Create a connector from a form

POST /api/v1/account/organizations/{id}/connectors/form

Badge

Validates a configuration document against the protocol’s form schema, merged with the inherited inventory and bundle values, and stores the connector’s own values.

Path parameters

id string required

Request body application/json required

configuration map[any] required
data_classes array[string]
endpoints array[object]
- endpoint string
environment string
integration object
- created_at string<date-time>
- fields map[array[object]] nullable
- id string<uuid>
- name string nullable
- protocols array[string] nullable
- supports array[string] nullable
- updated_at string<date-time>
- version string nullable
name string required
protocol string required
temperature string nullable
type string required
urn_id string<uuid>

Response 200 OK application/json

configuration map[object]
- filtered boolean nullable
- provider object nullable
  
  id string<uuid>
- value string
id string<uuid>
urn_id string<uuid>

Errors

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)

Every error returns the standard error body.

Request

curl -X POST 'https://pcp.example.com/api/v1/account/organizations/{id}/connectors/form' \
  -H 'Authorization: Bearer <badge>' \
  -H 'Content-Type: application/json' \
  -d '{
  "configuration": {
    "key": {}
  },
  "data_classes": [
    "string"
  ],
  "endpoints": [
    {
      "endpoint": "string"
    }
  ],
  "environment": "string",
  "integration": {
    "created_at": "2026-01-01T00:00:00Z",
    "fields": {
      "key": [
        {
          "default": "string",
          "description": "string",
          "display_name": "string",
          "enum": [
            "string"
          ],
          "inventory_value": "string",
          "name": "string",
          "pattern": "string",
          "required": true,
          "sensitive": true,
          "type": "string"
        }
      ]
    },
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "name": "string",
    "protocols": [
      "string"
    ],
    "supports": [
      "string"
    ],
    "updated_at": "2026-01-01T00:00:00Z",
    "version": "string"
  },
  "name": "string",
  "protocol": "string",
  "temperature": "string",
  "type": "string",
  "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
}'

Response 200

{
  "configuration": {
    "key": {
      "filtered": true,
      "provider": {
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
      },
      "value": "string"
    }
  },
  "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
  "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
}

Get a connector

GET /api/v1/connectors/{connector_id}

Badge

Path parameters

connector_id string required

Query parameters

organization_id string<uuid>

Organization to act on, at or below the caller’s. Defaults to the caller’s.

Response 200 OK application/json

access object
- can_author boolean
- can_delete boolean
- can_execute boolean
- can_view boolean
created_at string<date-time>
data_classes array[string] nullable
endpoints array[object]
- endpoint string
environment string nullable
fields map[object]
- filtered boolean nullable
- provider object nullable
  
  id string<uuid>
- value string
id string<uuid>
integration object
- created_at string<date-time>
- fields map[array[object]] nullable
- id string<uuid>
- name string nullable
- protocols array[string] nullable
- supports array[string] nullable
- updated_at string<date-time>
- version string nullable
inventory object nullable
- id string<uuid>
- name string
- residency string nullable
- type string
last_check string<date-time> nullable
name string
protocol string
resource object nullable
- class string
- configured_connectors array[object]
  
  country_detected string nullable
  
  id string<uuid>
  
  integration object
  
  created_at string<date-time>
  
  fields map[array[object]] nullable
  
  id string<uuid>
  
  name string nullable
  
  protocols array[string] nullable
  
  supports array[string] nullable
  
  updated_at string<date-time>
  
  version string nullable
  
  name string
  
  residency string nullable
  
  type string
- country_detected string nullable
- coverage_status string
- edge_pool_id string<uuid>
- effective_edge_pool_id string<uuid>
- 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 array[string]
- urn string
- urn_id string<uuid>
revision integer
root string
temperature string nullable
type string
updated_at string<date-time>

Errors

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)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/connectors/{connector_id}' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "access": {
    "can_author": true,
    "can_delete": true,
    "can_execute": true,
    "can_view": true
  },
  "created_at": "2026-01-01T00:00:00Z",
  "data_classes": [
    "string"
  ],
  "endpoints": [
    {
      "endpoint": "string"
    }
  ],
  "environment": "string",
  "fields": {
    "key": {
      "filtered": true,
      "provider": {
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
      },
      "value": "string"
    }
  },
  "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
  "integration": {
    "created_at": "2026-01-01T00:00:00Z",
    "fields": {
      "key": [
        {
          "default": "string",
          "description": "string",
          "display_name": "string",
          "enum": [
            "string"
          ],
          "inventory_value": "string",
          "name": "string",
          "pattern": "string",
          "required": true,
          "sensitive": true,
          "type": "string"
        }
      ]
    },
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "name": "string",
    "protocols": [
      "string"
    ],
    "supports": [
      "string"
    ],
    "updated_at": "2026-01-01T00:00:00Z",
    "version": "string"
  },
  "inventory": {
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "name": "string",
    "residency": "string",
    "type": "string"
  },
  "last_check": "2026-01-01T00:00:00Z",
  "name": "string",
  "protocol": "string",
  "resource": {
    "class": "string",
    "configured_connectors": [
      {
        "country_detected": "string",
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "integration": {
          "created_at": "2026-01-01T00:00:00Z",
          "fields": {
            "key": [
              {
                "default": "string",
                "description": "string",
                "display_name": "string",
                "enum": [
                  "string"
                ],
                "inventory_value": "string",
                "name": "string",
                "pattern": "string",
                "required": true,
                "sensitive": true,
                "type": "string"
              }
            ]
          },
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "name": "string",
          "protocols": [
            "string"
          ],
          "supports": [
            "string"
          ],
          "updated_at": "2026-01-01T00:00:00Z",
          "version": "string"
        },
        "name": "string",
        "residency": "string",
        "type": "string"
      }
    ],
    "country_detected": "string",
    "coverage_status": "string",
    "edge_pool_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "effective_edge_pool_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "excluded_from_coverage": true,
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "inventory_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "inventory_name": "string",
    "inventory_type": "string",
    "locked": true,
    "name": "string",
    "residency": "string",
    "service": "string",
    "subclass": "string",
    "tags": [
      "string"
    ],
    "urn": "string",
    "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
  },
  "revision": 0,
  "root": "string",
  "temperature": "string",
  "type": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}

Update a connector

POST /api/v1/connectors/{connector_id}

Badge

Path parameters

connector_id string required

Query parameters

organization_id string<uuid>

Organization to act on, at or below the caller’s. Defaults to the caller’s.

Request body application/json required

data_classes array[string]
endpoints array[object]
- endpoint string
environment string
fields map[object] required
- filtered boolean nullable
- provider object nullable
  
  id string<uuid>
- value string
integration object
- created_at string<date-time>
- fields map[array[object]] nullable
- id string<uuid>
- name string nullable
- protocols array[string] nullable
- supports array[string] nullable
- updated_at string<date-time>
- version string nullable
name string required
protocol string required
temperature string nullable
type string required
urn_id string<uuid>

Response 200 OK application/json

data_classes array[string] nullable
endpoints array[object]
- endpoint string
environment string nullable
fields map[object]
- filtered boolean nullable
- provider object nullable
  
  id string<uuid>
- value string
id string<uuid>
integration object
- created_at string<date-time>
- fields map[array[object]] nullable
- id string<uuid>
- name string nullable
- protocols array[string] nullable
- supports array[string] nullable
- updated_at string<date-time>
- version string nullable
last_check string<date-time> nullable
name string
protocol string
temperature string nullable
type string
urn_id string<uuid>

Errors

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)

Every error returns the standard error body.

Request

curl -X POST 'https://pcp.example.com/api/v1/connectors/{connector_id}' \
  -H 'Authorization: Bearer <badge>' \
  -H 'Content-Type: application/json' \
  -d '{
  "data_classes": [
    "string"
  ],
  "endpoints": [
    {
      "endpoint": "string"
    }
  ],
  "environment": "string",
  "fields": {
    "key": {
      "filtered": true,
      "provider": {
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
      },
      "value": "string"
    }
  },
  "integration": {
    "created_at": "2026-01-01T00:00:00Z",
    "fields": {
      "key": [
        {
          "default": "string",
          "description": "string",
          "display_name": "string",
          "enum": [
            "string"
          ],
          "inventory_value": "string",
          "name": "string",
          "pattern": "string",
          "required": true,
          "sensitive": true,
          "type": "string"
        }
      ]
    },
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "name": "string",
    "protocols": [
      "string"
    ],
    "supports": [
      "string"
    ],
    "updated_at": "2026-01-01T00:00:00Z",
    "version": "string"
  },
  "name": "string",
  "protocol": "string",
  "temperature": "string",
  "type": "string",
  "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
}'

Response 200

{
  "data_classes": [
    "string"
  ],
  "endpoints": [
    {
      "endpoint": "string"
    }
  ],
  "environment": "string",
  "fields": {
    "key": {
      "filtered": true,
      "provider": {
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
      },
      "value": "string"
    }
  },
  "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
  "integration": {
    "created_at": "2026-01-01T00:00:00Z",
    "fields": {
      "key": [
        {
          "default": "string",
          "description": "string",
          "display_name": "string",
          "enum": [
            "string"
          ],
          "inventory_value": "string",
          "name": "string",
          "pattern": "string",
          "required": true,
          "sensitive": true,
          "type": "string"
        }
      ]
    },
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "name": "string",
    "protocols": [
      "string"
    ],
    "supports": [
      "string"
    ],
    "updated_at": "2026-01-01T00:00:00Z",
    "version": "string"
  },
  "last_check": "2026-01-01T00:00:00Z",
  "name": "string",
  "protocol": "string",
  "temperature": "string",
  "type": "string",
  "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
}

Delete a connector

DELETE /api/v1/connectors/{connector_id}

Badge

Path parameters

connector_id string required

Query parameters

organization_id string<uuid>

Organization to act on, at or below the caller’s. Defaults to the caller’s.

Response 200 OK application/json

Errors

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)

Every error returns the standard error body.

Request

curl -X DELETE 'https://pcp.example.com/api/v1/connectors/{connector_id}' \
  -H 'Authorization: Bearer <badge>'

Response 200

{}

List what the caller may do on a connector

GET /api/v1/connectors/{connector_id}/capabilities

Badge

Path parameters

connector_id string required

Query parameters

organization_id string<uuid>

Organization to act on, at or below the caller’s. Defaults to the caller’s.

Response 200 OK application/json

actions array[string]
id string<uuid>
resource string

Errors

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)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/connectors/{connector_id}/capabilities' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "actions": [
    "string"
  ],
  "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
  "resource": "string"
}

Get a connector as form data

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

Badge

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>

Organization to act on, at or below the caller’s. Defaults to the caller’s.

Response 200 OK application/json

access object
- can_author boolean
- can_delete boolean
- can_execute boolean
- can_view boolean
configuration map[any]
created_at string<date-time>
data_classes array[string] nullable
endpoints array[object]
- endpoint string
environment string nullable
id string<uuid>
integration object
- created_at string<date-time>
- fields map[array[object]] nullable
- id string<uuid>
- name string nullable
- protocols array[string] nullable
- supports array[string] nullable
- updated_at string<date-time>
- version string nullable
inventory object nullable
- id string<uuid>
- name string
- residency string nullable
- type string
last_check string<date-time> nullable
name string
protocol string
resource object nullable
- class string
- configured_connectors array[object]
  
  country_detected string nullable
  
  id string<uuid>
  
  integration object
  
  created_at string<date-time>
  
  fields map[array[object]] nullable
  
  id string<uuid>
  
  name string nullable
  
  protocols array[string] nullable
  
  supports array[string] nullable
  
  updated_at string<date-time>
  
  version string nullable
  
  name string
  
  residency string nullable
  
  type string
- country_detected string nullable
- coverage_status string
- edge_pool_id string<uuid>
- effective_edge_pool_id string<uuid>
- 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 array[string]
- urn string
- urn_id string<uuid>
revision integer
root string
schema object
- bundle_fields map[object] nullable
  
  filtered boolean nullable
  
  provider object nullable
  
  id string<uuid>
  
  value string
- initial map[any]
- schema map[any]
- scheme string
temperature string nullable
type string
updated_at string<date-time>

Errors

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)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/connectors/{connector_id}/form' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "access": {
    "can_author": true,
    "can_delete": true,
    "can_execute": true,
    "can_view": true
  },
  "configuration": {
    "key": {}
  },
  "created_at": "2026-01-01T00:00:00Z",
  "data_classes": [
    "string"
  ],
  "endpoints": [
    {
      "endpoint": "string"
    }
  ],
  "environment": "string",
  "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
  "integration": {
    "created_at": "2026-01-01T00:00:00Z",
    "fields": {
      "key": [
        {
          "default": "string",
          "description": "string",
          "display_name": "string",
          "enum": [
            "string"
          ],
          "inventory_value": "string",
          "name": "string",
          "pattern": "string",
          "required": true,
          "sensitive": true,
          "type": "string"
        }
      ]
    },
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "name": "string",
    "protocols": [
      "string"
    ],
    "supports": [
      "string"
    ],
    "updated_at": "2026-01-01T00:00:00Z",
    "version": "string"
  },
  "inventory": {
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "name": "string",
    "residency": "string",
    "type": "string"
  },
  "last_check": "2026-01-01T00:00:00Z",
  "name": "string",
  "protocol": "string",
  "resource": {
    "class": "string",
    "configured_connectors": [
      {
        "country_detected": "string",
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
        "integration": {
          "created_at": "2026-01-01T00:00:00Z",
          "fields": {
            "key": [
              {
                "default": "string",
                "description": "string",
                "display_name": "string",
                "enum": [
                  "string"
                ],
                "inventory_value": "string",
                "name": "string",
                "pattern": "string",
                "required": true,
                "sensitive": true,
                "type": "string"
              }
            ]
          },
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
          "name": "string",
          "protocols": [
            "string"
          ],
          "supports": [
            "string"
          ],
          "updated_at": "2026-01-01T00:00:00Z",
          "version": "string"
        },
        "name": "string",
        "residency": "string",
        "type": "string"
      }
    ],
    "country_detected": "string",
    "coverage_status": "string",
    "edge_pool_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "effective_edge_pool_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "excluded_from_coverage": true,
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "inventory_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "inventory_name": "string",
    "inventory_type": "string",
    "locked": true,
    "name": "string",
    "residency": "string",
    "service": "string",
    "subclass": "string",
    "tags": [
      "string"
    ],
    "urn": "string",
    "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
  },
  "revision": 0,
  "root": "string",
  "schema": {
    "bundle_fields": {
      "key": {
        "filtered": true,
        "provider": {
          "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
        },
        "value": "string"
      }
    },
    "initial": {
      "key": {}
    },
    "schema": {
      "key": {}
    },
    "scheme": "string"
  },
  "temperature": "string",
  "type": "string",
  "updated_at": "2026-01-01T00:00:00Z"
}

Update a connector from a form

POST /api/v1/connectors/{connector_id}/form

Badge

Validates a configuration document against the connector’s protocol form schema, merged with the inherited values, and stores a new revision. Stored keys the schema does not show are kept.

Path parameters

connector_id string required

Request body application/json required

configuration map[any] required
data_classes array[string]
endpoints array[object]
- endpoint string
environment string
integration object
- created_at string<date-time>
- fields map[array[object]] nullable
- id string<uuid>
- name string nullable
- protocols array[string] nullable
- supports array[string] nullable
- updated_at string<date-time>
- version string nullable
name string required
protocol string required
temperature string nullable
type string required
urn_id string<uuid>

Response 200 OK application/json

configuration map[object]
- filtered boolean nullable
- provider object nullable
  
  id string<uuid>
- value string
id string<uuid>
urn_id string<uuid>

Errors

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)

Every error returns the standard error body.

Request

curl -X POST 'https://pcp.example.com/api/v1/connectors/{connector_id}/form' \
  -H 'Authorization: Bearer <badge>' \
  -H 'Content-Type: application/json' \
  -d '{
  "configuration": {
    "key": {}
  },
  "data_classes": [
    "string"
  ],
  "endpoints": [
    {
      "endpoint": "string"
    }
  ],
  "environment": "string",
  "integration": {
    "created_at": "2026-01-01T00:00:00Z",
    "fields": {
      "key": [
        {
          "default": "string",
          "description": "string",
          "display_name": "string",
          "enum": [
            "string"
          ],
          "inventory_value": "string",
          "name": "string",
          "pattern": "string",
          "required": true,
          "sensitive": true,
          "type": "string"
        }
      ]
    },
    "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
    "name": "string",
    "protocols": [
      "string"
    ],
    "supports": [
      "string"
    ],
    "updated_at": "2026-01-01T00:00:00Z",
    "version": "string"
  },
  "name": "string",
  "protocol": "string",
  "temperature": "string",
  "type": "string",
  "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
}'

Response 200

{
  "configuration": {
    "key": {
      "filtered": true,
      "provider": {
        "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
      },
      "value": "string"
    }
  },
  "id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90",
  "urn_id": "3f1e4a2c-9b7d-4e0f-8a11-2c5d6e7f8a90"
}

Reveal a connector's sensitive values

GET /api/v1/connectors/{connector_id}/secrets

Badge

Answers the literal sensitive values the other reads leave out, by name. Requires view on the connector and on the connector_secret class. Every call is journaled as secret.revealed.

Path parameters

connector_id string required

Query parameters

organization_id string<uuid>

Organization to act on, at or below the caller’s. Defaults to the caller’s.

Response 200 OK application/json

values map[any]

Errors

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)

Every error returns the standard error body.

Request

curl 'https://pcp.example.com/api/v1/connectors/{connector_id}/secrets' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "values": {
    "key": {}
  }
}

Create the store behind a connector

POST /api/v1/connectors/{connector_id}/stores/create

Badge

Path parameters

connector_id string required

Query parameters

organization_id string<uuid>

Organization to act on, at or below the caller’s. Defaults to the caller’s.

Request body application/json required

compression string nullable

Response 200 OK application/json

error string nullable
ok boolean

Errors

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)

Every error returns the standard error body.

Request

curl -X POST 'https://pcp.example.com/api/v1/connectors/{connector_id}/stores/create' \
  -H 'Authorization: Bearer <badge>' \
  -H 'Content-Type: application/json' \
  -d '{
  "compression": "string"
}'

Response 200

{
  "error": "string",
  "ok": true
}

Test a connector

POST /api/v1/connectors/{connector_id}/test

Badge

Path parameters

connector_id string required

Query parameters

organization_id string<uuid>

Organization to act on, at or below the caller’s. Defaults to the caller’s.

Response 200 OK application/json

error string nullable
ok boolean

Errors

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)

Every error returns the standard error body.

Request

curl -X POST 'https://pcp.example.com/api/v1/connectors/{connector_id}/test' \
  -H 'Authorization: Bearer <badge>'

Response 200

{
  "error": "string",
  "ok": true
}