Britive platform release 2026.09.02 is now live in production.

Update the description and/or name of a CSPM integration

Prev Next
Patch
/api/cspm/integrations/{name}

Updates the description and/or name of an existing CSPM integration. Both fields are optional in the request body -- omit either to leave it unchanged. The token, id, and ingest URL are never affected by a rename. Renaming to a name already used by another integration fails with the same uniqueness error as creation.

Security
HTTP
Type bearer
Path parameters
name
stringRequired

Either the unique, tenant-wide name given to this integration at creation, or its generated id ("cspm-"). The id is tried first (a direct lookup); if it doesn't match, the value is looked up as a name.

Body parameters
object

Request body for updating a CSPM integration

name
string

Optional new name for this integration. Omit to leave the name unchanged. If provided, must be non-blank and unique across all of this tenant's integrations (regardless of app type), same as at creation -- re-submitting the integration's current name is a no-op, not a conflict.

description
string

Updated description for this integration

Responses
200

Updated CSPM integration details

object

Stored details for a single CSPM integration (token not included)

app
string

CSPM application type

name
string

Unique, tenant-wide name given to this integration at creation

description
string

Description of this integration

ingestUrl
string

URL to which CSPM events should be sent (/-ingest/)

createdOn
string

Timestamp when the active token was created. Updated on each rotation -- it tracks the token, not the integration record -- so this reflects when the token was last rotated, not necessarily when the integration itself was first created.

actionTemplate
string

The app's outbound webhook payload/action template (e.g. Wiz's Mustache-syntax action template), to be pasted as-is into the CSPM tool's own webhook/action configuration so the events it sends match the shape this integration ingests. Identical for every integration of a given app type -- not customized per integration. Absent if the app has no such template. Also always absent on List all CSPM integrations (the list response) -- it's only included when a single integration is returned (Get/Update CSPM integration details), since repeating an identical value on every list row would be wasted payload.

400

The new name is blank, or already used by a different integration

404

No integration found with the given name or id