CTctrlplanedev

Get system

Changed on
get/v1/workspaces/{workspaceId}/systems/{systemId}

Request

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

Path parameters

workspaceIdstring required

ID of the workspace

systemIdstring required

ID of the system

Response

OK response

descriptionstring
idstring required
metadataobject
namestring required
slugstring required
workspaceIdstring required

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