VEverdun
integrations

Update Integration

Edit the connection's ONE display field: the vendor console's org short name. No provider call, no secret read or write, no status change.

It is a separate route rather than part of credentials because it cannot touch the credential at all — see SiteIntegrationsService.update_integration for why that separation is the point, and why a create-only field would have been unreachable for every connection that already exists in production.

patch/parents/{parent_id}/integrations/{integration_id}

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/parents/{parent_id}/integrations/{integration_id}
  • Auth
    HTTP bearer

Path parameters

parent_idstring required
integration_idstring required

Request body

command_short_namestring nullable required

The vendor console's organization short name (the subdomain in https://<short-name>.command.verkada.com/...). Owner-entered and never fetched from the provider. Lowercase letters, digits and hyphens only. Send null or an empty string to clear it. REQUIRED in this body: an omitted field is a 422, so an empty PATCH cannot silently clear a stored value.

Example request

{
  "command_short_name": "northgate-security"
}

Response

Successful Response

idstring uuid required

The integration record ID.

parent_idstring uuid required

The client this connection belongs to. The credential is client-level; WHICH SITES it serves is site_ids.

provider'verkada' | 'turing' | 'avertx' required
labelstring required

Operator-facing name for this connection.

external_org_idstring nullable

Provider organization id (non-secret), for display.

command_short_namestring nullable

The vendor console's organization short name (the subdomain in https://<short-name>.command.verkada.com/...). Owner-entered, never fetched from the provider, and used only to build an operator's deep link. A Verkada concept: providers whose console has no such deep link leave it null.

status'active' | 'error' required
last_verified_atstring date-time nullable

When the connection last tested successfully.

last_errorstring nullable

Most recent connection-test failure, sanitized and truncated. Never contains a credential.

site_idsstring[]

The live sites this connection is assigned to, ordered by id. Empty means UNASSIGNED: the connection is listed and manageable but no site uses it yet. Absent from payloads of older servers (read as empty).

created_atstring date-time required

When the connection was created.

updated_atstring date-time nullable

When the connection was last modified.

Example response

{
  "label": "Northgate Command",
  "external_org_id": "ceb8ff18-0000-0000-0000-000000000000",
  "command_short_name": "northgate-security",
  "last_error": "The provider rejected the supplied API key."
}

Changes

No recorded changes to this operation across all 2 revisions of this API.