Add system environment associations

POST

/api-catalog/system-environments/:systemEnvironmentId/associations

POST

/api-catalog/system-environments/:systemEnvironmentId/associations

$ curl -X POST https://api.getpostman.com/api-catalog/system-environments/23b554c1-c30c-483d-bf98-dbe9ab7b88a0/associations \
>      -H "x-api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "workspaceEnvironmentIds": [
>     "12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619",
>     "56781234-c71c146a-ee75-4e3d-b1c4-dacc28577ffa",
>     "87654321-9b83df88-9b5c-445b-ac23-460c37897340"
>   ]
> }'

1 {
2   "meta": {
3     "created": 1,
4     "existing": 1,
5     "replaced": 1,
6     "excluded": 0
7   },
8   "data": [
9     {
10       "workspaceEnvironmentId": "12345678-4b076607-09cf-4f9d-8a9a-08c8f3cf4619",
11       "status": "existing",
12       "id": "019d3e30-6768-7770-91f0-a2010c886619",
13       "workspaceId": "4540d410-ef72-4977-afb8-d7f53705f379",
14       "associatedAt": "2026-03-30T04:30:52.000Z"
15     },
16     {
17       "workspaceEnvironmentId": "56781234-c71c146a-ee75-4e3d-b1c4-dacc28577ffa",
18       "status": "replaced",
19       "id": "019d3e31-323f-7770-91f0-b2c7d9b0ca21",
20       "workspaceId": "a5edcd30-c773-4f88-9660-9590bc0af96b",
21       "associatedAt": "2026-03-30T10:01:44.767Z",
22       "previousSystemEnvironmentId": "23b554c1-c30c-483d-bf98-dbe9ab7b88a0"
23     },
24     {
25       "workspaceEnvironmentId": "87654321-9b83df88-9b5c-445b-ac23-460c37897340",
26       "status": "created",
27       "id": "019d3e31-323f-7770-91f0-bc5a64c75930",
28       "workspaceId": "a5450abd-ec89-443c-a17a-68132e738714",
29       "associatedAt": "2026-03-30T10:01:44.767Z"
30     }
31   ]
32 }

Adds workspace-environment associations to a system environment.

Authentication

x-api-keystring

API Key authentication via header

Authorizationstring

A valid SCIM API key for calls to SCIM endpoints.

A valid [SCIM API key](https://learning.postman.com/docs/administration/scim-provisioning/scim-provisioning-overview/#generating-scim-api-key) for calls to SCIM endpoints.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

systemEnvironmentIdstringRequired

The system environment's ID.

Query parameters

allowPartialbooleanOptionalDefaults to false

If false, the system only adds associations when there are no status errors. If true, the system skips any ineligible associations and adds eligible associations.

Request

This endpoint expects an object.

workspaceEnvironmentIdslist of stringsRequired

A list of workspace environment IDs to remove. Accepts both the environment ID or the environment’s unique ID (userId-environmentId).

Response

Successful Response

metaobject

The response's meta information for paginated results.

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error