API ReferenceEndpoints

Create an endpoint

resourceGroupIds and secrets[].secretReferenceId must reference resource groups / secret references that belong to this same namespace, otherwise the request returns 400.

Authentication

AuthorizationBearer

WorkOS organization API key (Authorization: Bearer sk_…).

Path parameters

namespaceIdstringRequiredformat: "uuid"

Headers

Idempotency-KeystringOptional

Optional idempotency key; a replay within the retention window returns the stored response.

Request

This endpoint expects an object.
methodenumRequired
hoststringRequired
pathstringRequired

Must start with ”/”.

statusenumOptionalDefaults to 1
metadatamap from strings to anyOptional
Arbitrary JSON object, or null.
resourceGroupIdslist of stringsOptional
secretslist of objectsOptional

Response

Created
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error