Open Connector
Mapping API

Mapping API

Confirm and remove relationships between resource identities while preserving each source product record.

Confirm and remove relationships between resource identities while preserving each source product record.

Use the shared request contract for authentication, pagination, preconditions, idempotency, and common errors. Exact response members are defined in API data types and the downloadable OpenAPI contract.

List mappings

GET/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/mappings
Scope
mappings:read
Auth
Bearer API key

Lists confirmed relationships and stale references for the connection.

Query parameters
limitintegeroptional

Number of records; bounds are inclusive.

default50rule1–200
cursorstringoptional

Opaque continuation; preserve the original filters.

200Result

Returns a data array of Mapping records, pagination.next_cursor, and request_id.

Create a mapping

POST/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/mappings
Scope
mappings:write
Auth
Bearer API key
Repeat calls
Organization-scoped Idempotency-Key; 24 hours

Confirms a relationship between resource keys on opposite endpoints.

Requires Idempotency-Key.

Both resources must be visible under the current grant and the caller must have destination mapping authority. Missing resources return 404; unsupported pairs return 422 incompatible_resources; an existing pair returns 409 mapping_exists.

Creation does not enroll an agent or admit a traffic route.

Request body
source_resource_keystringrequired

Qualified identity on one connection endpoint.

rule1–200 characters
destination_resource_keystringrequired

Qualified identity on the other endpoint.

rule1–200 characters
reasonstringrequired

Why these records represent the same workload.

rule1–2000 characters
201Created

Returns data as Mapping, plus request_id.

Read a mapping

GET/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/mappings/{mapping_id}
Scope
mappings:read
Auth
Bearer API key

Returns both qualified identities, the reason, and stale-reference state.

200Result

Returns data as Mapping, plus request_id.

Delete a mapping

DELETE/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/mappings/{mapping_id}
Scope
mappings:write
Auth
Bearer API key

Removes the relationship without deleting either referenced resource.

Requires If-Match from a current read.

Previously delivered observations remain historical records. A replacement workload requires a separately reviewed mapping for its replacement resource key.

204Removed

Returns no body.