# Control plane (/docs/swivy/api-reference/control-plane)

<Callout type="warn" title="Testnet preview">
Staging uses software custody. Use your environment’s API base URL and test assets only.
</Callout>

33 operations from the November 1, 2026 deployed contract. [Full OpenAPI schema](/swivy/openapi.json) · [Live interactive reference](https://swivy.swopme.co/docs#reference).

## List chain capabilities [#list-chain-capabilities]

<EndpointHeader method="GET" path="/v1/control/chains/capabilities" base={false} />

**Auth:** No operation-level credentials specified; deployment and policy restrictions still apply.

**Responses:** `200` Capabilities

## Get signer infrastructure status [#get-signer-infrastructure-status]

<EndpointHeader method="GET" path="/v1/control/infrastructure/signer" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

**Responses:** `200` Signer status · `401` Invalid or missing admin token

## Create an organization [#create-an-organization]

<EndpointHeader method="POST" path="/v1/control/organizations" base={false} />

**Auth:** `x-admin-token`

**Request body:** required. Organization payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | Yes |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Created organization and issued its initial owner credential · `401` Invalid or missing admin token

## Create a project [#create-a-project]

<EndpointHeader method="POST" path="/v1/control/organizations/{organizationId}/projects" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |

**Request body:** required. Project payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | Yes |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Created project · `401` Invalid or missing admin token

## Rename a project [#rename-a-project]

<EndpointHeader method="PATCH" path="/v1/control/projects/{projectId}" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `projectId` | path | Yes | Project identifier |

**Request body:** required. Project payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | Yes |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Updated project · `401` Invalid or missing control-plane credential · `404` Project not found · `409` Project slug already exists in this organization

## Create an environment and issue its first credential pair [#create-an-environment-and-issue-its-first-credential-pair]

<EndpointHeader method="POST" path="/v1/control/projects/{projectId}/environments" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `projectId` | path | Yes | Project identifier |

**Request body:** required. Environment payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | Yes |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Created environment · `401` Invalid or missing admin token

## Rename an environment [#rename-an-environment]

<EndpointHeader method="PATCH" path="/v1/control/environments/{environmentId}" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Request body:** required. Environment payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | Yes |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Updated environment · `401` Invalid or missing control-plane credential · `404` Environment not found · `409` Environment slug already exists in this project

## List environment credentials [#list-environment-credentials]

<EndpointHeader method="GET" path="/v1/control/environments/{environmentId}/credentials" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Responses:** `200` Credential list · `401` Invalid or missing admin token

## Rotate or create a new environment credential pair [#rotate-or-create-a-new-environment-credential-pair]

<EndpointHeader method="POST" path="/v1/control/environments/{environmentId}/credentials" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Request body:** optional. Credential creation payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `label` | string | No |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Created environment credential · `401` Invalid or missing admin token · `404` Environment not found

## Revoke an environment credential pair [#revoke-an-environment-credential-pair]

<EndpointHeader method="DELETE" path="/v1/control/environments/{environmentId}/credentials/{credentialId}" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |
| `credentialId` | path | Yes | Credential identifier |

**Responses:** `200` Credential revoked · `401` Invalid or missing admin token · `404` Credential not found

## Get organization overview [#get-organization-overview]

<EndpointHeader method="GET" path="/v1/control/organizations/{organizationId}/overview" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |

**Responses:** `200` Organization overview · `401` Invalid or missing control-plane credential · `404` Organization not found

## List organization admin credentials [#list-organization-admin-credentials]

<EndpointHeader method="GET" path="/v1/control/organizations/{organizationId}/admin-credentials" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |

**Responses:** `200` Organization admin credential list · `401` Invalid or missing control-plane credential · `403` Credential is outside this organization or lacks read access · `404` Organization not found

## Create an organization admin credential [#create-an-organization-admin-credential]

<EndpointHeader method="POST" path="/v1/control/organizations/{organizationId}/admin-credentials" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |

**Request body:** optional. Organization admin credential payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `label` | string | No |  |
| `role` | object | No |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Created organization admin credential · `401` Invalid or missing control-plane credential · `403` Credential lacks owner access for this organization · `404` Organization not found

## List organization members [#list-organization-members]

<EndpointHeader method="GET" path="/v1/control/organizations/{organizationId}/members" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |

**Responses:** `200` Organization member list · `401` Invalid or missing control-plane credential · `403` Credential is outside this organization or lacks read access · `404` Organization not found

## Update an organization member role and sync their active admin credentials [#update-an-organization-member-role-and-sync-their-active-admin-credentials]

<EndpointHeader method="PATCH" path="/v1/control/organizations/{organizationId}/members/{memberId}" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |
| `memberId` | path | Yes | Organization member identifier |

**Request body:** required. Organization member role payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `role` | string | Yes | Allowed: owner, admin, developer, viewer |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Organization member updated · `401` Invalid or missing control-plane credential · `403` Credential lacks owner access for this organization · `404` Organization or member not found · `409` Update would remove the last active owner credential

## Revoke an organization member and deactivate their admin credentials [#revoke-an-organization-member-and-deactivate-their-admin-credentials]

<EndpointHeader method="DELETE" path="/v1/control/organizations/{organizationId}/members/{memberId}" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |
| `memberId` | path | Yes | Organization member identifier |

**Responses:** `200` Organization member revoked · `401` Invalid or missing control-plane credential · `403` Credential lacks owner access for this organization · `404` Organization or member not found · `409` Revocation would remove the last active owner credential

## List organization invites [#list-organization-invites]

<EndpointHeader method="GET" path="/v1/control/organizations/{organizationId}/invites" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |

**Responses:** `200` Organization invite list · `401` Invalid or missing control-plane credential · `403` Credential is outside this organization or lacks read access · `404` Organization not found

## Create an organization invite [#create-an-organization-invite]

<EndpointHeader method="POST" path="/v1/control/organizations/{organizationId}/invites" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |

**Request body:** required. Organization invite payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `email` | string | Yes |  |
| `role` | object | No |  |
| `expiresInHours` | integer | No |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Created organization invite · `401` Invalid or missing control-plane credential · `403` Credential lacks owner access for this organization · `404` Organization not found

## Revoke an organization invite [#revoke-an-organization-invite]

<EndpointHeader method="DELETE" path="/v1/control/organizations/{organizationId}/invites/{inviteId}" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |
| `inviteId` | path | Yes | Organization invite identifier |

**Responses:** `200` Organization invite revoked · `401` Invalid or missing control-plane credential · `403` Credential lacks owner access for this organization · `404` Organization or invite not found

## Revoke an organization admin credential [#revoke-an-organization-admin-credential]

<EndpointHeader method="DELETE" path="/v1/control/organizations/{organizationId}/admin-credentials/{credentialId}" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `organizationId` | path | Yes | Organization identifier |
| `credentialId` | path | Yes | Organization admin credential identifier |

**Responses:** `200` Organization admin credential revoked · `401` Invalid or missing control-plane credential · `403` Credential lacks owner access for this organization · `404` Organization or credential not found · `409` Revocation would remove the last active owner credential

## Accept an organization invite and mint an org-scoped admin credential [#accept-an-organization-invite-and-mint-an-org-scoped-admin-credential]

<EndpointHeader method="POST" path="/v1/control/organization-invites/{inviteId}/accept" base={false} />

**Auth:** No operation-level credentials specified; deployment and policy restrictions still apply.

| Parameter | Location | Required | Description |
|---|---|---|---|
| `inviteId` | path | Yes | Organization invite identifier |

**Request body:** required. Organization invite acceptance payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `token` | string | Yes |  |
| `name` | string | No |  |
| `label` | string | No |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Accepted organization invite · `404` Invite not found · `409` Invite expired, already used, or member already exists

## Replace environment policy [#replace-environment-policy]

<EndpointHeader method="PUT" path="/v1/control/environments/{environmentId}/policy" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Request body:** required. Environment policy

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `loginPolicy` | object | No |  |
| `allowedChains` | array | Yes |  |
| `exportPolicy` | object | Yes |  |
| `signingPolicy` | object | Yes |  |
| `executionPolicy` | object | Yes |  |
| `walletToolPolicy` | object | No |  |
| `walletPolicy` | object | Yes |  |
| `serverWalletPolicy` | object | No | When requireAuthorizationKey is true (the default), server wallets need an Ed25519 authorization key and every intent must be signed with it. |
| `offlineSigningPolicy` | object | No |  |
| `blockchainDataPolicy` | object | No |  |
| `rpcProviderPolicy` | object | No |  |
| `sessionPolicy` | object | Yes |  |
| `recoveryPolicy` | object | Yes |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Updated environment policy · `401` Invalid or missing admin token

## Get environment dashboard snapshot [#get-environment-dashboard-snapshot]

<EndpointHeader method="GET" path="/v1/control/environments/{environmentId}/dashboard" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Responses:** `200` Environment dashboard · `401` Invalid or missing admin token · `404` Environment not found

## List environment RPC targets [#list-environment-rpc-targets]

<EndpointHeader method="GET" path="/v1/control/environments/{environmentId}/chains" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Responses:** `200` Environment RPC targets · `401` Invalid or missing admin token

## Create or update an environment RPC target [#create-or-update-an-environment-rpc-target]

<EndpointHeader method="PUT" path="/v1/control/environments/{environmentId}/chains/{chain}" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |
| `chain` | path | Yes | Chain family |

**Request body:** required. Chain RPC target configuration

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `network` | string | No |  |
| `rpcUrl` | string | Yes |  |
| `wsUrl` | anyOf | No |  |
| `headers` | array | No |  |
| `commitment` | anyOf | No |  |
| `skipPreflight` | boolean | No |  |
| `maxRetries` | anyOf | No |  |
| `enabled` | boolean | No |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Updated environment RPC target · `401` Invalid or missing admin token

## Create a webhook endpoint [#create-a-webhook-endpoint]

<EndpointHeader method="POST" path="/v1/control/environments/{environmentId}/webhooks" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Request body:** required. Webhook target

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `url` | string | Yes |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Created webhook · `401` Invalid or missing admin token

## List webhooks [#list-webhooks]

<EndpointHeader method="GET" path="/v1/control/environments/{environmentId}/webhooks" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Responses:** `200` Webhook list · `401` Invalid or missing admin token

## Rotate a webhook signing secret [#rotate-a-webhook-signing-secret]

<EndpointHeader method="POST" path="/v1/control/environments/{environmentId}/webhooks/{webhookId}/rotate-secret" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |
| `webhookId` | path | Yes | Webhook identifier |

**Responses:** `200` Rotated webhook secret · `401` Invalid or missing admin token · `404` Webhook not found

## Revoke a webhook endpoint [#revoke-a-webhook-endpoint]

<EndpointHeader method="DELETE" path="/v1/control/environments/{environmentId}/webhooks/{webhookId}" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |
| `webhookId` | path | Yes | Webhook identifier |

**Responses:** `200` Revoked webhook · `401` Invalid or missing admin token · `404` Webhook not found

## List environment audit logs [#list-environment-audit-logs]

<EndpointHeader method="GET" path="/v1/control/environments/{environmentId}/audit" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Responses:** `200` Audit logs · `401` Invalid or missing admin token

## List OIDC clients for an environment [#list-oidc-clients-for-an-environment]

<EndpointHeader method="GET" path="/v1/control/environments/{environmentId}/oidc-clients" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Responses:** `200` OIDC client list · `401` Invalid or missing control-plane credential · `404` Environment not found

## Create an OIDC client for Sign in with Swop [#create-an-oidc-client-for-sign-in-with-swop]

<EndpointHeader method="POST" path="/v1/control/environments/{environmentId}/oidc-clients" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |

**Request body:** required. OIDC client payload

Content type: `application/json`.

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | string | Yes |  |
| `redirectUris` | array | Yes |  |
| `scopes` | array | No |  |
| `grantTypes` | array | No |  |
| `tokenEndpointAuthMethod` | string | No | Allowed: none, client_secret_post, client_secret_basic |
| `applicationType` | string | No | Allowed: web, spa, native |
| `brandColor` | string | No |  |
| `logoUrl` | string | No |  |
| `authMethods` | object | No |  |

Nested schemas and constraints are in the [OpenAPI document](/swivy/openapi.json).

**Responses:** `200` Created OIDC client · `401` Invalid or missing control-plane credential · `404` Environment not found

## Revoke an OIDC client [#revoke-an-oidc-client]

<EndpointHeader method="DELETE" path="/v1/control/environments/{environmentId}/oidc-clients/{clientId}" base={false} />

**Auth:** `x-swivy-admin-key` **or** `x-admin-token`

| Parameter | Location | Required | Description |
|---|---|---|---|
| `environmentId` | path | Yes | Environment identifier |
| `clientId` | path | Yes | OIDC client identifier |

**Responses:** `200` OIDC client revoked · `401` Invalid or missing control-plane credential · `404` Environment or OIDC client not found
