Documentation menu
Definitions

Create an Environment Definition

POST /api/v1/projects/{projectId}/environments/{environmentId}/definitions

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Create an Environment Definition.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Create an Environment Definition.

Request body

Required — Request body for: Create an Environment Definition.

application/json

NameTypeRequiredDescription
sourceobjectrequired
attachmentsarray<object>optional
kind"domain" | "integration" | "operation" | "presentation"required
slugstringrequired
namestringrequired

Responses

StatusDescriptionBody
201Response for status 201application/json — object — id: string (required); projectId: string (required); kind: "domain" | "integration" | "operation" | "presentation" (required); slug: string (required); name: string (required); status: "active" | "deleting" (required); latestRevision: object | null (required); organizationId: string (required); environmentId: string (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)