openapi: 3.2.0 info: title: Ensighten Manage Publish Paths 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: Publish Paths description: 'CRUD operations with Publish Paths. For further details or guidance on configuring Publish Path settings, please consult our Help Center article available here. Publish Path specific fields Field Required Description Valid Values name Y The name of the publish path A name up to 30 characters codeGen N Code generation settings for the publish path An object containing codegen configuration (see below) Codegen specific fields These fields are nested within the codeGen object. If the codeGen object is omitted on create, the defaults indicated below will be applied. On update, only the fields provided will be modified. Field Required Description Valid Values namespace N Parent object reference for the publish path A name up to 30 characters Defaults to "Bootstrapper" if none provided versionId N The id of the Bootstrap version name. Versions V1 through V8 are depr' paths: /manage/publishpaths/search: post: operationId: postManagePublishpathsSearch summary: Search publish paths tags: - Publish Paths security: - ApiKeyAuth: [] - BearerAuth: [] description: A search with no matching records returns 404 Not Found instead of an empty array. Treat this 404 as an empty result set. requestBody: required: true content: application/json: example: fields: id, clientId, name, codeGen filters: name: - dev page: 1 per_page: 10 sort: -name responses: '200': description: OK content: application/json: example: - id: 1234 clientId: 321 name: dev codeGen: versionId: 14 minificationLevelId: 1 languageId: 3 '404': description: Not Found content: application/json: example: code: 404 message: Not Found description: No publish paths could be found given the passed criteria. /manage/publishpaths/{name}: post: operationId: postManagePublishpathsName summary: Create a publish path tags: - Publish Paths security: - ApiKeyAuth: [] - BearerAuth: [] description: '[DEPRECATED] API endpoint to create a Publish Path was moved to /manage/publishpaths.' parameters: - name: name in: path required: true description: Publish path name. schema: type: string example: myPublishPath responses: '201': description: Created content: application/json: example: id: 1 publishPath: myPublishPath clientId: 1 isDeleted: false codeGenArgs: publishPathId: 1 namespace: null serverComponentPath: null serverComponentRuleCodePath: null serverComponentRuleCodePathForSCTemplate: null customCodegenCommand: null codeGenVersion: id: 32 version: v8_20220915 description: insertScript custom attributes, Data Definition resolved status hasCustomCodeGen: false minificationLevelId: null languageId: null /manage/publishpaths: post: operationId: postManagePublishpaths summary: Create a publish path tags: - Publish Paths security: - ApiKeyAuth: [] - BearerAuth: [] requestBody: required: true content: application/json: example: name: my-publish-path codeGen: namespace: Bootstrapper versionId: 14 minificationLevelId: 1 languageId: 3 sriHashAlgorithmId: 1 nexusContextId: 1 responses: '201': description: Created content: application/json: example: id: 1 name: my-publish-path clientId: 1 codeGen: namespace: Bootstrapper versionId: 14 minificationLevelId: 1 languageId: 3 sriHashAlgorithmId: 1 nexusContextId: 1 '400': description: Bad Request content: application/json: example: code: 400 message: Bad Request description: Publish path name "this_publish_path_has_too_many_characters" is invalid. First character must be alphanumeric, dashes and underscores are also allowed after that, and the total length must be at most 30. /manage/publishpaths/{id}: get: operationId: getManagePublishpathsId summary: Get a publish path tags: - Publish Paths security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true description: Numeric id of the publish path id to perform action with. schema: type: number example: '1' responses: '200': description: OK content: application/json: example: id: 1 name: my-publish-path clientId: 1 codeGen: namespace: Bootstrapper versionId: 14 minificationLevelId: 1 languageId: 3 sriHashAlgorithmId: 1 nexusContextId: 1 '400': description: Bad Request content: application/json: example: code: 400 message: Bad Request description: The publish path id is invalid '404': description: Not Found content: application/json: example: code: 404 message: Not Found description: Publish Path not found put: operationId: putManagePublishpathsId summary: Update a publish path tags: - Publish Paths security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true description: Numeric id of the publish path id to perform action with. schema: type: number example: '1' requestBody: required: true content: application/json: example: codeGen: namespace: Bootstrapper versionId: 14 minificationLevelId: 1 languageId: 3 sriHashAlgorithmId: 1 nexusContextId: 1 responses: '200': description: OK content: application/json: example: id: 1 name: my-publish-path clientId: 1 codeGen: namespace: Bootstrapper versionId: 14 minificationLevelId: 1 languageId: 3 sriHashAlgorithmId: 1 nexusContextId: 1 '400': description: Bad Request content: application/json: example: code: 400 message: Bad Request description: The publish path id is invalid '404': description: Not Found content: application/json: example: code: 404 message: Not Found description: The publish path could not be found. delete: operationId: deleteManagePublishpathsId summary: Delete a publish path tags: - Publish Paths security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true description: Numeric id of the publish path id to perform action with. schema: type: number example: '1' 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.