CTctrlplanedev

Preview release targets for a resource

Changed on

Simulates which release targets would be created if the given resource were added to the workspace. This is a dry-run endpoint — no resources or release targets are actually created.

post/v1/workspaces/{workspaceId}/release-targets/resource-preview

Request

  • Base URL
    http://localhost:3001/api
  • URL
    http://localhost:3001/api/v1/workspaces/{workspaceId}/release-targets/resource-preview
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

workspaceIdstring required

ID of the workspace

Query parameters

limitinteger

Maximum number of items to return

offsetinteger

Number of items to skip

Request body

configobject required
identifierstring required
kindstring required
metadataobject required
namestring required
versionstring required

Response

Paginated list of items

limitinteger required

Maximum number of items returned

offsetinteger required

Number of items skipped

totalinteger required

Total number of items available

Changes

  • 6199a729d4a1Revision changes
    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

  • e8cfb6371d5eRevision changes
    • info

      the response property /// became required for the status