openapi: 3.2.0 info: title: Ensighten Manage Deployments API version: 1.0.0 description: "This is the REST Manage API that can be used by Ensighten Manage customers.\n\n\nThere are currently two ways to authenticate through the Manage API: API Key and Username / Password.\n\n\nAll API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate for all requests.\n\n\nSupported Entities\n\n- \nSpaces\n\n\n\n\n- \nPublish Paths\n\n\n\n\n- \nDeployments\n\n\n\n\n- \nConditions\n\n\n\n\n- \nData Definitions\n\n\n\n\n- \nEvent Definitions\n\n\n\n\n- \nUsers\n\n\n\n\n- \nRoles\n\n\n\n\n- \nSCIM 2.0\n\n\n\n\n- \nGit\n\n\n\n\n- \nTDN" contact: name: Ensighten Support url: https://help.ensighten.com/hc/en-us x-derived-from: API Blueprint published by Ensighten at https://manageexternalapi.docs.apiary.io/ x-blueprint-last-updated: '2026-07-14T18:41:23.848Z' servers: - url: https://manage-api.ensighten.com description: Production (from the Apiary blueprint urls.production) - url: https://private-anon-6a32b48ac3-manageexternalapi.apiary-mock.com description: Apiary anonymous mock server (example payloads only) security: - ApiKeyAuth: [] - BearerAuth: [] tags: - name: Deployments description: "CRUD operations with Deployments.\n\n\nImportant Deployment specific fields\n\n\n\nField\nDescription\nValid Values\n\n\n\n\nid\nThe deployment id\n\n\n\nname\nThe name of the deployment\nA name up to 255 characters\n\n\nspaceId\nThe id of the space this deployment is available in\n\n\n\nspaceName\nThe name of the space this deployment is available in\n\n\n\nstatus\nRefers to state the deployment is in.\nThis is sent back as a field in response to GET deployment.\ndisabled_uncommitted \n disabled_committed \n disabled_published \n enabled_uncommitted \n enabled_committed \n enabled_published \n deleted_uncommitted \n deleted_committed \n deleted_published \n archived_uncommitted \n archived_committed \n archived_published\n\n\npreviousStatus\nRefers to the state the deployment was in before the last action was performed\n\n\n\nlastPublishedStatus\nRefers to the state the deployment was in when it was published last\n\n\n\nlastAction\nRefers to the" paths: /manage/deployments: get: operationId: getManageDeployments summary: Get deployments tags: - Deployments security: - ApiKeyAuth: [] - BearerAuth: [] description: A request where no deployments match the query parameters returns 404 Not Found instead of an empty array (even when the account has no deployments yet). Treat this 404 as an empty result set. parameters: - name: name in: query required: false description: Get deployments with the name. schema: type: string example: mydeployment - name: spaceId in: query required: false description: get deployments in space. schema: type: string example: '605' - name: status in: query required: false description: get deployments that are in a given status (enabled_committed, enabled_published, enabled_uncommitted, deleted_committed, deleted_published, deleted_uncommitted, disabled_committed, disabled_published, disabled_uncommitted, archived_committed, archived_published, archived_uncommitted) schema: type: string example: enabled_published - name: code in: query required: false description: get deployments with tag code. schema: type: string example: var x = 1; - name: sinceCreated in: query required: false description: get deployments that were created on or after a date in GMT. schema: type: string example: '2013-08-07' - name: untilCreated in: query required: false description: get deployments that were created before or on a date in GMT. schema: type: string example: '2014-08-07' - name: sinceUpdated in: query required: false description: get deployments that were updated on or after a date in GMT. schema: type: string example: '2014-09-07' - name: untilUpdated in: query required: false description: get deployments that were updated before or on a date in GMT. schema: type: string example: '2014-09-07' - name: page in: query required: false description: Get a specific page. Is applicable only in conjunction with the 'per_page' parameter. schema: type: number example: '1' - name: per_page in: query required: false description: Limit the per page results and defaults to 10 with a maximum of 50. Is applicable only in conjunction with the 'page' parameter. schema: type: number example: '10' responses: '200': description: OK content: application/json: example: - id: 31126 spaceId: 605 name: mydeployment isCustomApp: true status: enabled_published executionTime: immediate comments: comment for the app code: console.log("var x = 1;"); dependentDeployments: - deploymentId: 51658 spaceId: 1475 conditionIds: - 67234 - 67268 eventIds: [] spaceName: demo appId: 24 appName: Custom JavaScript previousStatus: enabled_committed lastAction: publish ruleId: 1165344 labels: - key: Lifecycle value: prod modifyDate: '2014-09-07T17:43:48.000Z' lastActionDate: '2014-09-07T17:43:48.000Z' creationDate: '2014-08-25T17:43:48.000Z' lastPublishedVid: 0 '404': description: Not Found content: application/json: example: code: 404 message: Not Found description: No deployments could be found given the passed criteria. /manage/deployments/search: post: operationId: postManageDeploymentsSearch summary: Search deployments tags: - Deployments security: - ApiKeyAuth: [] - BearerAuth: [] description: A search with no matching records returns 404 Not Found instead of an empty array (even when the account has no deployments yet). Treat this 404 as an empty result set. requestBody: required: true content: application/json: example: fields: id, spaceId, name, isCustomApp, status, executionTime, comments, code, dependentDeployments, conditionIds, labels, ruleId, creationDate sort: +name filters: spaceId: - 605 name: - test-deploy labels: Lifecycle: - prod - stage responses: '200': description: OK content: application/json: example: - id: 31126 spaceId: 605 name: test-deploy isCustomApp: true status: enabled_uncommitted executionTime: immediate comments: comment for the app code: console.log("testing app creation"); dependentDeployments: - deploymentId: 51658 spaceId: 1475 conditionIds: - 67234 - 67268 labels: - key: Lifecycle value: prod ruleId: 1166344 creationDate: '2013-04-25T17:43:48.000Z' '404': description: Not Found content: application/json: example: code: 404 message: Not Found description: No deployments could be found given the passed criteria. /manage/spaces/{spaceId}/deployments/{id}: get: operationId: getManageSpacesSpaceidDeploymentsId summary: Get a deployment tags: - Deployments security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: spaceId in: path required: true description: Numeric id of the space that this deployment is associated with. schema: type: number example: '605' - name: id in: path required: true description: Numeric id of the deployment to perform action with. schema: type: number example: '31126' responses: '200': description: OK content: application/json: example: id: 31126 spaceId: 605 name: test-deploy isCustomApp: true status: enabled_uncommitted executionTime: immediate comments: comment for the app code: console.log("testing app creation"); dependentDeployments: - deploymentId: 51658 spaceId: 1475 conditionIds: - 67234 - 67268 eventIds: [] spaceName: demo appId: 24 appName: Custom JavaScript previousStatus: enabled_committed lastAction: uncommit labels: - key: Lifecycle value: prod modifyDate: '2013-04-25T17:43:48.000Z' lastActionDate: '2013-05-25T17:43:48.000Z' creationDate: '2013-03-25T17:43:48.000Z' lastPublishedVid: 0 '400': description: Bad Request content: application/json: example: code: 400 message: Bad Request description: The deployment or space id is invalid '404': description: Not Found content: application/json: example: code: 404 message: Not Found description: The deployment could not be found. put: operationId: putManageSpacesSpaceidDeploymentsId summary: Update a Deployment tags: - Deployments security: - ApiKeyAuth: [] - BearerAuth: [] description: Note - Only Custom JS deployments are able to be updated through the API. parameters: - name: spaceId in: path required: true description: Numeric id of the space that this deployment is associated with. schema: type: number example: '605' - name: id in: path required: true description: Numeric id of the deployment to perform action with. schema: type: number example: '31126' requestBody: required: true content: application/json: example: name: test-deploy executionTime: immediate comments: comment for the app code: console.log("testing app creation"); dependentDeployments: - deploymentId: 51658 spaceId: 1475 conditionIds: - 67234 - 67268 responses: '204': description: No Content '400': description: Bad Request content: application/json: example: code: 400 message: Bad Request description: The deployment or space id is invalid '404': description: Not Found content: application/json: example: code: 404 message: Not Found description: Unable to find space with space id - 111111 delete: operationId: deleteManageSpacesSpaceidDeploymentsId summary: Delete a Deployment tags: - Deployments security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: spaceId in: path required: true description: Numeric id of the space that this deployment is associated with. schema: type: number example: '605' - name: id in: path required: true description: Numeric id of the deployment to perform action with. schema: type: number example: '31126' responses: '204': description: No Content '400': description: Bad Request content: application/json: example: code: 400 message: Bad Request description: The deployment or space id is invalid '404': description: Not Found content: application/json: example: code: 404 message: Not Found description: Unable to find deployment with deployment id - 111111 /manage/spaces/{spaceId}/deployments: post: operationId: postManageSpacesSpaceidDeployments summary: Create a deployment tags: - Deployments security: - ApiKeyAuth: [] - BearerAuth: [] description: Note - Only Custom JS deployments are able to be created through the API. parameters: - name: spaceId in: path required: true description: Numeric id of the space that this deployment is associated with. schema: type: number requestBody: required: true content: application/json: example: name: test-deploy executionTime: immediate comments: comment for the app code: console.log("testing app creation"); dependentDeployments: - deploymentId: 51658 spaceId: 1475 conditionIds: - 67234 - 67268 labels: - key: Lifecycle value: prod responses: '200': description: OK content: application/json: example: id: 31126 spaceId: 605 name: test-deploy isCustomApp: true status: enabled_uncommitted executionTime: immediate comments: comment for the app code: console.log("testing app creation"); dependentDeployments: - deploymentId: 51658 spaceId: 1475 conditionIds: - 67234 - 67268 labels: - key: Lifecycle value: prod '400': description: Bad Request content: application/json: example: code: 400 message: Bad Request description: The space id is invalid /manage/spaces/{spaceId}/deployments/{id}/{action}: put: operationId: putManageSpacesSpaceidDeploymentsIdAction summary: Enable / Disable / Commit / Uncommit / Undelete / Archive / Unarchive a Deployment tags: - Deployments security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: spaceId in: path required: true description: Numeric id of the space id to perform action with. schema: type: number example: '605' - name: id in: path required: true description: Numeric id of the deployment to perform action with. schema: type: number example: '31126' - name: action in: path required: true description: String value to indicate if its an enable, disable, commit, uncommit, undelete, archive, or unarchive operation. schema: type: string example: enable responses: '200': description: OK content: application/json: example: spaceId: 5511 commitId: '123' requestedDate: '2024-01-01 12:34:56' deploymentId: 68000 '204': description: No Content '400': description: Bad Request content: application/json: example: code: 400 message: Bad Request description: The deployment or space id is invalid /manage/spaces/deployments/batch/{action}: put: operationId: putManageSpacesDeploymentsBatchAction summary: Commit / Uncommit Deployments tags: - Deployments security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: action in: path required: true description: String value to indicate if its a batch commit or uncommit operation. schema: type: string example: commit requestBody: required: true content: application/json: example: deploymentIds: - 61367 - 61368 spaceIds: - 6020 - 6020 responses: '200': description: OK content: application/json: example: "{\n \"success\": [\n {\n \"deploymentId\": 61367,\n \"deploymentName\": \"deploy1\",\n \"spaceId\": 6020,\n \"spaceName\": \"prod\",\n \"detail\": null,\n \"jobId\": \"123\" // commitId\n }\n ],\n \"failure\": [\n {\n \"deploymentId\": 61368,\n \"deploymentName\": \"deploy2\",\n \"spaceId\": 6020,\n \"spaceName\": \"prod\",\n \"detail\": \"invalid state found for the deployment\",\n \"jobId\": null\n }\n ]\n}" /manage/spaces/{spaceId}/deployments/{id}/merge/{targetSpaceId}: put: operationId: putManageSpacesSpaceidDeploymentsIdMergeTargetspaceid summary: Merge tags: - Deployments security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: spaceId in: path required: true description: Numeric id of the space that this deployment is associated with. schema: type: number example: '605' - name: id in: path required: true description: Numeric id of the deployment to perform action with. schema: type: number example: '31126' - name: targetSpaceId in: path required: true description: Numeric id of the target space that this deployment is to be merged into. schema: type: number example: '706' responses: '204': description: No Content components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: API Key created in the Admin > API Keys page of Manage. Keys are prefixed 'ens_'. Not accepted on /auth/token. BearerAuth: type: http scheme: bearer description: Access token obtained from POST /auth/token (OAuth 2.0 Resource Owner Password Credentials flow). OAuth2Password: type: oauth2 flows: password: tokenUrl: https://manage-api.ensighten.com/auth/token scopes: {} description: Resource Owner Password Credentials flow. No OAuth scopes are documented; authorization is governed by Manage Roles assigned to the user or API Key.