{"name":"Manage API","subdomain":"manageexternalapi","rootSubdomain":"manageexternalapi","lastUpdated":"2026-07-14T18:41:23.848Z","apiDescriptionFormat":"apiblueprint","owner":{"_id":"555416a5f2c4a10300f80b0f","name":"Ensighten "},"user":{"trafficSecret":"6a32b48ac3","isAnonymous":true},"urls":{"mock":"https://private-anon-6a32b48ac3-manageexternalapi.apiary-mock.com/","production":"https://manage-api.ensighten.com/","proxy":"https://private-anon-6a32b48ac3-manageexternalapi.apiary-proxy.com/"},"preferences":{"privateTraffic":true,"privateDocumentation":false,"defaultConsoleMode":"cloud","documentation":{}},"permissions":{"editApi":false,"accessApiSettings":false,"inviteViewer":false,"inviteEditor":false,"viewTests":false,"viewApiBlueprint":false},"editors":[],"team":{"_id":"555416a5f2c4a10300f80b0e"},"authDefinitions":[],"dataStructures":[],"blueprint":"","description":"\u003cp>This is the REST \u003cstrong>Manage API\u003c/strong> that can be used by Ensighten Manage customers.\u003c/p>\n\u003cp>There are currently two ways to authenticate through the Manage API: \u003cstrong>API Key\u003c/strong> and \u003cstrong>Username / Password\u003c/strong>.\u003c/p>\n\u003cp>All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate for all requests.\u003c/p>\n\u003ch2>Supported Entities\u003c/h2>\n\u003cul>\n\u003cli>\n\u003cp>Spaces\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Publish Paths\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Deployments\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Conditions\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Data Definitions\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Event Definitions\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Users\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Roles\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>SCIM 2.0\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Git\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>TDN\u003c/p>\n\u003c/li>\n\u003c/ul>","toc":{"introduction":{"items":[{"level":2,"name":"Supported Entities","subitems":[]}],"lowestLevel":2}},"resourceGroups":[{"name":"API Key","description":"\u003cp>To create a new API Key, navigate to the "API Keys" page in the Admin section of your Manage account. When creating an API Key,\nyou will need to provide a Name and assign relevant Roles to the API Key.\u003c/p>\n\u003cp>After saving, you will receive your API Key. This will be the only time the API key is visible, so ensure you record it securely.\nIf lost, you can reset your API key at any time.\u003c/p>\n\u003ch5>API Request\u003c/h5>\n\u003cp>API Key authentication requires passing the API Key in every request using the \u003ccode>X-API-Key\u003c/code> header.\u003c/p>\n\u003ch5>Example\u003c/h5>\n\u003cpre>\u003ccode>X-API-Key: ens_01hL1o3iAHKHObEfLM0JKk9hfUYp6KOvsAbY\n\u003c/code>\u003c/pre>\n\u003cp>\u003cstrong>Note:\u003c/strong> The authentication endpoints (\u003ccode>/auth/token\u003c/code>) do not support API Key authentication.\nIf you are using an API Key, you can directly authenticate your requests without needing a token.\u003c/p>","resources":[]},{"name":"Authentication","description":"\u003cp>Requests using a username and password for authentication follow the \u003ca href=\"http://tools.ietf.org/html/rfc6749#section-4.3\">Resource Owner Password Flow\u003c/a> of the OAuth 2.0\nspecification.\u003c/p>\n\u003ch5>API Request\u003c/h5>\n\u003cp>Once a token has been retrieved using the \u003ccode>/auth/token\u003c/code> process below,  include it in all API calls using the \u003ccode>Authorization\u003c/code> header.\u003c/p>\n\u003ch5>Example\u003c/h5>\n\u003cpre>\u003ccode>Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA\n\u003c/code>\u003c/pre>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/auth/token","actions":[{"name":"Username/Password/MultiFactor Authentication","relation":"","uriTemplate":"","description":"\u003cp>In order to gain an access token for use with the API a call must be made using a valid account name, user name, and password. If the account is MFA configured, MFA verification code is also needed.\u003c/p>\n\u003cp>The \u003ccode>Authorization\u003c/code> header contains the Base64 encoded concatenation of the account name, user name, and password.\nFor example, the value \u003ccode>mycompany:joe:mypassword\u003c/code> would be encoded and used in the header value.\u003c/p>\n\u003cp>The \u003ccode>MultiFactorAuthentication\u003c/code> header is needed if the account is MFA configured which is a 6 digits number that is created from Google Authentication App on the phone.\u003c/p>\n\u003cp>The \u003ccode>grant_type\u003c/code> of \u003cem>password\u003c/em> must be included in the body.\u003c/p>","method":"POST","parameters":[],"headers":{},"examples":[{"requests":[{"body":"grant_type=password","schema":"","description":"","headers":{"Content-Type":"application/x-www-form-urlencoded","Authorization":"Basic am9lOm15cGFzc3dvcmQ=","Accept":"application/json","MultiFactorAuthentication":"123456"},"headers1A":[{"name":"Content-Type","value":"application/x-www-form-urlencoded"},{"name":"Authorization","value":"Basic am9lOm15cGFzc3dvcmQ="},{"name":"Accept","value":"application/json"},{"name":"MultiFactorAuthentication","value":"123456"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n   \"access_token\": \"2YotnFZFEjr1zCsicMWpAA\",\n   \"token_type\": \"bearer\",\n   \"expires_in\": 3600,\n   \"refresh_token\": \"tGzv3JOkF0XG5Qx2TlKWIA\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]},{"name":"Refreshing Access Tokens","relation":"","uriTemplate":"","description":"\u003cp>All access tokens granted will automatically expire after the timeframe specified when retrieving the token,\nso all developer code must cater for refreshing tokens.\u003c/p>\n\u003cp>To request a new token, provide the \u003ccode>Authorization\u003c/code> header (see \u003ccode>Username/Password Authentication\u003c/code>) along with the parameter of \u003ccode>grant_type=refresh_token\u003c/code> as well as \u003ccode>refresh_token\u003c/code> with the token\nsupplied in the previous token grant must be included in the body.\u003c/p>","method":"POST","parameters":[],"headers":{},"examples":[{"requests":[{"body":"grant_type=refresh_token\nrefresh_token=REFRESH_TOKEN","schema":"","description":"","headers":{"Content-Type":"application/x-www-form-urlencoded","Authorization":"Basic am9lOm15cGFzc3dvcmQ="},"headers1A":[{"name":"Content-Type","value":"application/x-www-form-urlencoded"},{"name":"Authorization","value":"Basic am9lOm15cGFzc3dvcmQ="}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n   \"access_token\": \"2YotnFZFEjr1zCsicMWpAA\",\n   \"expires_in\": 3600,\n   \"refresh_token\": \"tGzv3JOkF0XG5Qx2TlKWIA\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]}],"description":""}]},{"name":"Spaces","description":"\u003cp>CRUD operations with \u003cstrong>Spaces\u003c/strong>.\u003c/p>\n\u003ch2>Space specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Required\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">name\u003c/td>\n\u003ctd align=\"left\">Y\u003c/td>\n\u003ctd align=\"left\">The name of the space\u003c/td>\n\u003ctd align=\"left\">A name up to 255 characters\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">publishPaths\u003c/td>\n\u003ctd align=\"left\">Y\u003c/td>\n\u003ctd align=\"left\">A list of either existing paths (provide id) or new ones (provide name)\u003c/td>\n\u003ctd align=\"left\">An array of paths (e.g. [{"id": 1665}, {"publishPath": "stage"}])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">mandatedConditionIds\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">A list of valid condition ids to associate with the space\u003c/td>\n\u003ctd align=\"left\">An array of ids (e.g. [67275, 67228])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">mandatedConditions\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">A list of conditions associated with this deployment\u003c/td>\n\u003ctd align=\"left\">An array of objects containing condition id and name (e.g. [{"id": 51234, "name": "demoAllPages"}])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">mandatedDeployments\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">A list of deployments mandated by the space\u003c/td>\n\u003ctd align=\"left\">An array of objects containing deployment id, deployment name, space id and space name (e.g. [{"id": 51234, "name": "demoAllPages", "spaceId": 1234, "spaceName": "example"}])\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003ch2>JSON Schema\u003c/h2>\n\u003cp>Conforms to JSON schema draft v4 specifications\u003c/p>\n\u003cpre>\u003ccode>    {\n        "description": "JSON Schema for space create request",\n        "type": "object",\n        "properties": {\n            "name": {"type": "string", "minLength": 1},\n            "publishPaths": {\n                "type": "array",\n                "minItems": 1,\n                "items": {"type": "object",\n                    "properties": {\n                        "publishPath": {"type": "string"},\n                        "id": {"type": "number", "maximum": 2147483647}\n                    }\n                }\n            },\n            "mandatedConditionIds": {\n                "type": "array",\n                "minItems": 0,\n                "items": {"type": "number", "maximum": 2147483647},\n                "uniqueItems": true\n            },\n            "mandatedDeployments": {\n                "type": "array",\n                "minItems": 0,\n                "items": {"type": "object",\n                    "properties": {\n                        "deploymentId": {"type": "number", "maximum": 2147483647},\n                        "spaceId": {"type": "number", "maximum": 2147483647}\n                    }\n                }\n            }\n        },\n        "required": ["name", "publishPaths"]\n    }\n\u003c/code>\u003c/pre>\n\u003cpre>\u003ccode>    {\n        "description": "JSON Schema for space fetch request",\n        "type": "object",\n        "properties": {\n            "name": {"type": "string", "minLength": 1},\n            "publishPaths": {\n                "type": "array",\n                "minItems": 1,\n                "items": {"type": "object",\n                    "properties": {\n                        "publishPath": {"type": "string"},\n                        "id": {"type": "number", "maximum": 2147483647}\n                    }\n                }\n            },\n            "mandatedConditionIds": {\n                "type": "array",\n                "minItems": 0,\n                "items": {"type": "number", "maximum": 2147483647},\n                "uniqueItems": true\n            },\n            "mandatedConditions": {\n                "type": "array",\n                "minItems": 0,\n                "items": {"type": "object",\n                    "properties": {\n                        "id": {"type": "number", "minimum": 0, "maximum": 2147483647},\n                        "name": {"type": "string", "minLength": 1}\n                    }\n                }\n            },\n            "mandatedDeployments": {\n              "type": "array",\n              "minItems": 0,\n              "items": {\n                "type": "object",\n                "properties": {\n                  "id": {\n                    "type": "integer"\n                  },\n                  "name": {\n                    "type": "string"\n                  },\n                  "spaceId": {\n                    "type": "integer"\n                  },\n                  "spaceName": {\n                    "type": "string"\n                  }\n                },\n                "required": [\n                  "id",\n                  "name",\n                  "spaceId",\n                  "spaceName"\n                ]\n              }\n            }\n        }\n    }\n\u003c/code>\u003c/pre>\n\u003cpre>\u003ccode>{\n    "description": "JSON Schema for space update request",\n    "type": "object",\n    "properties": {\n        "name": {"type": "string", "minLength": 1},\n\n       "publishPaths": {\n            "type": "array",\n            "minItems": 1,\n            "items": {"type": "object",\n            "properties": {"id": {"type": "number", "maximum": 2147483647}},\n            "required": ["id"]\n            }\n           },\n        "mandatedConditionIds": {\n            "type": "array",\n            "minItems": 0,\n            "items": {"type": "number", "maximum": 2147483647},\n            "uniqueItems": true\n        },\n        "mandatedDeployments": {\n            "type": "array",\n            "minItems": 0,\n            "items": {"type": "object",\n                "properties": {\n                    "deploymentId": {"type": "number", "maximum": 2147483647},\n                    "spaceId": {"type": "number", "maximum": 2147483647}\n                }\n            }\n        }\n    },\n    "required": ["name", "publishPaths"]\n}\n\u003c/code>\u003c/pre>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/spaces{?name}{?publishPath}{?page}{?per_page}","actions":[{"name":"Search spaces","relation":"","uriTemplate":"","description":"\u003cblockquote>\n\u003cp>A search with no matching records returns \u003ccode>404 Not Found\u003c/code> instead of an empty array. Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"GET","parameters":[{"description":"\u003cp>Get spaces with the name.\u003c/p>\n","type":"string","required":false,"default":"","example":"myspace","values":[],"key":"name"},{"description":"\u003cp>get spaces that are associated with a specific publish path.\u003c/p>\n","type":"string","required":false,"default":"","example":"mypath","values":[],"key":"publishPath"},{"description":"\u003cp>Get a specific page\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Limit the per page results and defaults to 10 with a maximum of 50.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[{\n    \"id\": 606,\n    \"name\": \"stage\",\n    \"mandatedConditionIds\": [67275, 67228],\n    \"mandatedConditions\": [{\"id\": 67275, \"name\": \"tr_aug5_condition\"}, {\"id\": 67228, \"name\": \"tr_sep5_condition\"}],\n    \"publishPaths\": [{\"id\": 1665, \"publishPath\": \"stage\"}],\n    \"lastPublished\": \"2015-05-17T04:00:26.000Z\",\n    \"mandatedDeployments\": []\n},\n{\n    \"id\": 607,\n    \"name\": \"prod\",\n    \"mandatedConditionIds\": [67275, 67228],\n    \"mandatedConditions\": [{\"id\": 67275, \"name\": \"tr_aug5_condition\"}, {\"id\": 67228, \"name\": \"tr_sep5_condition\"}],\n    \"publishPaths\": [{\"id\": 1666, \"publishPath\": \"prod\"}],\n    \"lastPublished\": \"2015-07-15T04:12:26.000Z\",\n    \"mandatedDeployments\": [{\"id\": 12345, \"name\": \"d1\", \"spaceId\": 54321, \"spaceName\": \"s1\"}]\n}]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No spaces could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the space id to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"1","values":[],"key":"id"}],"uriTemplate":"/manage/spaces/{id}","actions":[{"name":"Get a space by id","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 606,\n    \"name\": \"stage\",\n    \"mandatedConditionIds\": [67275, 67228],\n    \"mandatedConditions\": [{\"id\": 67275, \"name\": \"tr_aug5_condition\"}, {\"id\": 67228, \"name\": \"tr_sep5_condition\"}],\n    \"publishPaths\": [{\"id\": 1665, \"publishPath\": \"stage\"}],\n    \"lastPublished\": \"2015-05-17T04:00:26.000Z\",\n    \"mandatedDeployments\": []\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The space id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No spaces could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Update a space","relation":"","uriTemplate":"","description":"\u003cp>When making a request to update an existing space, the \u003ccode>publishPath\u003c/code> field may only contain existing paths\nthat are identified by their \u003ccode>id\u003c/code>.\u003c/p>","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"name\": \"stage\",\n    \"publishPaths\": [{\"id\": 1665}],\n    \"mandatedConditionIds\": [67275, 67228],\n    \"mandatedDeployments\": [{\"deploymentId\": 1, \"spaceId\": 2}]\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The space id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"}],"name":"","description":""}]},{"name":"Delete a space","relation":"","uriTemplate":"","description":"","method":"DELETE","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01..."},"headers1A":[{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The space id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/spaces","actions":[{"name":"Create a space","relation":"","uriTemplate":"","description":"","method":"POST","parameters":[{"description":"\u003cp>Space name\u003c/p>\n","type":"String","required":true,"default":"","example":"","values":[],"key":"name"},{"description":"\u003cp>comma-separated list of publishPath object which has publishPath name string, empty list means no publishPath mapping to the space\u003c/p>\n","type":"List","required":true,"default":"","example":"","values":[],"key":"publishPaths"},{"description":"\u003cp>comma-separated list of condition ids\u003c/p>\n","type":"List","required":false,"default":"","example":"","values":[],"key":"mandatedConditionIds"},{"description":"\u003cp>'true' to create a git repository correspondingly\u003c/p>\n","type":"boolean","required":false,"default":"","example":"","values":[],"key":"isGitEnabled"},{"description":"\u003cp>comma-separated list of deploymentId and spaceId object\u003c/p>\n","type":"List","required":false,"default":"","example":"","values":[],"key":"mandatedDeployments"}],"headers":{},"examples":[{"requests":[{"body":"{\n    \"name\": \"stage\",\n    \"publishPaths\": [{\"publishPath\": \"stage\"}],\n    \"mandatedConditionIds\": [67275, 67228],\n    \"isGitEnabled\": true,\n    \"mandatedDeployments\": [{\"deploymentId\": 1, \"spaceId\": 2}]\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 899\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"201"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the space id to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"1","values":[],"key":"id"}],"uriTemplate":"/manage/spaces/{id}/publish","actions":[{"name":"Publish a space","relation":"","uriTemplate":"","description":"\u003cp>When publishing a space, the process will start and return an identifier. That identifier\ncan be used to call the API in order to check the status of the publish.\u003c/p>","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"spaceId\": 899,\n    \"publishId\": \"123\",\n    \"requestedDate\": \"2014-12-19T17:59:08.465Z\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n  \"code\": 412,\n  \"message\": \"Precondition Failed\",\n  \"description\": \"The space is currently being published and thus can't be published at this time.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"412"}],"name":"","description":""}]},{"name":"Publish a space - Selective","relation":"","uriTemplate":"","description":"\u003cp>When publishing a space, the process will start and return an identifier. That identifier\ncan be used to call the API in order to check the status of the publish.\u003c/p>\n\u003cp>Selective Publish will only publish the Deployments corresponding to the specified deploymentIds, along with all non-deployment items (Conditions, Data Definitions, ...).\u003c/p>\n\u003cp>All specified Deployments must be committed before publishing.\u003c/p>","method":"PATCH","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n  \"deploymentIds\": [123, 456, 789]\n}","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"spaceId\": 1,\n    \"publishId\": \"222\",\n    \"requestedDate\": \"2025-02-01T01:02:03.456Z\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"Error on publish: Tag - 123 is not committed.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the space id to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"1","values":[],"key":"id"},{"description":"\u003cp>The identifier for the publish action.\u003c/p>\n","type":"string","required":true,"default":"","example":"123","values":[],"key":"publishId"}],"uriTemplate":"/manage/spaces/{id}/publish/{publishId}","actions":[{"name":"Publish Status","relation":"","uriTemplate":"","description":"\u003cp>Use a publish identifier to check the status of the publish action.\u003c/p>","method":"GET","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"spaceId\": 1,\n    \"publishId\": \"123\",\n    \"complete\": true,\n    \"success\": true\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the space id to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"1","values":[],"key":"id"},{"description":"\u003cp>The identifier for the commit action.\u003c/p>\n","type":"string","required":true,"default":"","example":"456","values":[],"key":"commitId"}],"uriTemplate":"/manage/spaces/{id}/commit/{commitId}","actions":[{"name":"Commit Status","relation":"","uriTemplate":"","description":"\u003cp>Use a commit identifier to check the status of the commit action.\u003c/p>","method":"GET","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"spaceId\": 1,\n    \"commitId\": \"456\",\n    \"complete\": true,\n    \"success\": true\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]}],"description":""}]},{"name":"Publish Paths","description":"\u003cp>CRUD operations with \u003cstrong>Publish Paths\u003c/strong>.\u003c/p>\n\u003cp>For further details or guidance on configuring Publish Path settings, please consult our Help Center article available \u003ca href=\"https://help.ensighten.com/hc/en-us/articles/22962372006673-Publish-Path-Settings\">here\u003c/a>.\u003c/p>\n\u003ch2>Publish Path specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Required\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">name\u003c/td>\n\u003ctd align=\"left\">Y\u003c/td>\n\u003ctd align=\"left\">The name of the publish path\u003c/td>\n\u003ctd align=\"left\">A name up to 30 characters\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">codeGen\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Code generation settings for the publish path\u003c/td>\n\u003ctd align=\"left\">An object containing codegen configuration (see below)\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003ch2>Codegen specific fields\u003c/h2>\n\u003cp>These fields are nested within the \u003ccode>codeGen\u003c/code> object. If the \u003ccode>codeGen\u003c/code> object is omitted on create, the defaults indicated below will be applied. On update, only the fields provided will be modified.\u003c/p>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Required\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">namespace\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Parent object reference for the publish path\u003c/td>\n\u003ctd align=\"left\">A name up to 30 characters\u003cbr>\u003cbr>Defaults to "Bootstrapper" if none provided\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">versionId\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">The id of the \u003ca href=\"https://help.ensighten.com/hc/en-us/articles/22962517944593-Bootstrap-Revision-History\">Bootstrap version name\u003c/a>. Versions V1 through V8 are deprecated (see the \u003ca href=\"https://help.ensighten.com/hc/en-us/articles/33893549548561\">Bootstrap Version Support Policy\u003c/a> for details).\u003c/td>\n\u003ctd align=\"left\">1 - v1_20190727\u003cbr> 2 - v2_20191031\u003cbr> 3 - v3_20200123\u003cbr> 5 - v4_20200406 \u003cbr> 6 - v5_20200514\u003cbr> 7 - v6_20201029\u003cbr> 8 - v7_20220512\u003cbr> 9 - v8_20220915\u003cbr> 10 - v9_20230706\u003cbr> 11 - v10\u003cbr> 12 - v11\u003cbr> 13 - v12\u003cbr>  14 - v13 \u003cstrong>(default)\u003c/strong>\u003cbr>\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">minificationLevelId\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Affects how the Manage deployed code is compiled\u003c/td>\n\u003ctd align=\"left\">1 - Whitespace \u003cstrong>(default)\u003c/strong>\u003cbr>2 - Simple\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">languageId\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">ECMAScript language version\u003c/td>\n\u003ctd align=\"left\">1 - ECMASCRIPT_2018\u003cbr>2 - ECMASCRIPT_2019 \u003cbr>3 - ECMASCRIPT_2020 \u003cstrong>(default)\u003c/strong>\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">sriHashAlgorithmId\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Subresource Integrity (SRI)\u003c/td>\n\u003ctd align=\"left\">1 - Disabled \u003cstrong>(default)\u003c/strong>\u003cbr>2 - Enabled [SHA-256]\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">nexusContextId\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Nexus Context\u003c/td>\n\u003ctd align=\"left\">1 - Disabled \u003cstrong>(default)\u003c/strong>\u003cbr>2 - Enabled\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/publishpaths/search","actions":[{"name":"Search publish paths","relation":"","uriTemplate":"","description":"\u003cblockquote>\n\u003cp>A search with no matching records returns \u003ccode>404 Not Found\u003c/code> instead of an empty array. Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"POST","parameters":[{"description":"\u003cp>Get the requested fields for the resulting publish paths.\u003c/p>\n","type":"string","required":false,"default":"","example":"id, clientId, name, codeGen","values":[],"key":"fields"},{"description":"\u003cp>Sort the resulting publish paths by the given field name. Acceptable field names are 'id', 'name', 'codeGen.versionId', 'codeGen.minificationLevelId' and 'codeGen.languageId'. A '-' prefix indicates sort in descending order.\u003c/p>\n","type":"string","required":false,"default":"","example":"-name","values":[],"key":"sort"},{"description":"\u003cp>Filters publish paths based on the given parameters. Acceptable parameters in this object are\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>"id" (comma-seperated list of publish path Ids)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"name" (comma-seperated list of publish path names)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"namespace" (comma-separated list of namespaces)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"spaceId" (comma-separated list of space Ids)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"codeGenVersionId" (comma-separated list of bootstrap version Ids)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"minificationLevelId" (comma-separated list of minification level Ids)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"languageId" (comma-separated list of ECMAScript language Ids)\u003c/p>\n\u003c/li>\n\u003c/ul>\n","type":"object","required":false,"default":"","example":"","values":[],"key":"filters"},{"description":"\u003cp>Get a specific page. Is applicable only in conjunction with the 'per_page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Limit the per page results. Is applicable only in conjunction with the 'page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"{\n    \"fields\": \"id, clientId, name, codeGen\",\n    \"filters\": {\"name\": [\"dev\"]},\n    \"page\": 1,\n    \"per_page\": 10,\n    \"sort\": \"-name\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[{\n    \"id\": 1234,\n    \"clientId\": 321,\n    \"name\": \"dev\",\n    \"codeGen\": {\n        \"versionId\": 14,\n        \"minificationLevelId\": 1,\n        \"languageId\": 3\n    }\n}]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No publish paths could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/publishpaths/{name}","actions":[{"name":"Create a publish path","relation":"","uriTemplate":"","description":"\u003cp>\u003cstrong>[DEPRECATED]\u003c/strong> API endpoint to create a Publish Path was moved to \u003ccode>/manage/publishpaths\u003c/code>.\u003c/p>","method":"POST","parameters":[{"description":"\u003cp>Publish path name.\u003c/p>\n","type":"string","required":true,"default":"","example":"myPublishPath","values":[],"key":"name"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 1,\n    \"publishPath\": \"myPublishPath\",\n    \"clientId\": 1,\n    \"isDeleted\": false,\n    \"codeGenArgs\": {\n        \"publishPathId\": 1,\n        \"namespace\": null,\n        \"serverComponentPath\": null,\n        \"serverComponentRuleCodePath\": null,\n        \"serverComponentRuleCodePathForSCTemplate\": null,\n        \"customCodegenCommand\": null,\n        \"codeGenVersion\": {\n            \"id\": 32,\n            \"version\": \"v8_20220915\",\n            \"description\": \"insertScript custom attributes, Data Definition resolved status\"\n        },\n        \"hasCustomCodeGen\": false,\n        \"minificationLevelId\": null,\n        \"languageId\": null\n    }\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"201"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/publishpaths","actions":[{"name":"Create a publish path","relation":"","uriTemplate":"","description":"","method":"POST","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"name\": \"my-publish-path\",\n    \"codeGen\": {\n        \"namespace\": \"Bootstrapper\",\n        \"versionId\": 14,\n        \"minificationLevelId\": 1,\n        \"languageId\": 3,\n        \"sriHashAlgorithmId\": 1,\n        \"nexusContextId\": 1\n    }\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 1,\n    \"name\": \"my-publish-path\",\n    \"clientId\": 1,\n    \"codeGen\": {\n        \"namespace\": \"Bootstrapper\",\n        \"versionId\": 14,\n        \"minificationLevelId\": 1,\n        \"languageId\": 3,\n        \"sriHashAlgorithmId\": 1,\n        \"nexusContextId\": 1\n    }\n}","schema":"","description":"","headers":{},"headers1A":[],"status":"201"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"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.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the publish path id to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"1","values":[],"key":"id"}],"uriTemplate":"/manage/publishpaths/{id}","actions":[{"name":"Get a publish path","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 1,\n    \"name\": \"my-publish-path\",\n    \"clientId\": 1,\n    \"codeGen\": {\n        \"namespace\": \"Bootstrapper\",\n        \"versionId\": 14,\n        \"minificationLevelId\": 1,\n        \"languageId\": 3,\n        \"sriHashAlgorithmId\": 1,\n        \"nexusContextId\": 1\n    }\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The publish path id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"Publish Path not found\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Update a publish path","relation":"","uriTemplate":"","description":"","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"codeGen\": {\n        \"namespace\": \"Bootstrapper\",\n        \"versionId\": 14,\n        \"minificationLevelId\": 1,\n        \"languageId\": 3,\n        \"sriHashAlgorithmId\": 1,\n        \"nexusContextId\": 1\n    }\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 1,\n    \"name\": \"my-publish-path\",\n    \"clientId\": 1,\n    \"codeGen\": {\n        \"namespace\": \"Bootstrapper\",\n        \"versionId\": 14,\n        \"minificationLevelId\": 1,\n        \"languageId\": 3,\n        \"sriHashAlgorithmId\": 1,\n        \"nexusContextId\": 1\n    }\n}","schema":"","description":"","headers":{},"headers1A":[],"status":"200"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The publish path id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"The publish path could not be found.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Delete a publish path","relation":"","uriTemplate":"","description":"","method":"DELETE","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01..."},"headers1A":[{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"}],"name":"","description":""}]}],"description":""}]},{"name":"Deployments","description":"\u003cp>CRUD operations with \u003cstrong>Deployments\u003c/strong>.\u003c/p>\n\u003ch2>Important Deployment specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">id\u003c/td>\n\u003ctd align=\"left\">The deployment id\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">name\u003c/td>\n\u003ctd align=\"left\">The name of the deployment\u003c/td>\n\u003ctd align=\"left\">A name up to 255 characters\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">spaceId\u003c/td>\n\u003ctd align=\"left\">The id of the space this deployment is available in\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">spaceName\u003c/td>\n\u003ctd align=\"left\">The name of the space this deployment is available in\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">status\u003c/td>\n\u003ctd align=\"left\">Refers to state the deployment is in.\u003cbr>This is sent back as a field in response to GET deployment.\u003c/td>\n\u003ctd align=\"left\">disabled_uncommitted \u003cbr> disabled_committed \u003cbr> disabled_published \u003cbr>  enabled_uncommitted \u003cbr> enabled_committed \u003cbr> enabled_published \u003cbr> deleted_uncommitted \u003cbr> deleted_committed \u003cbr> deleted_published \u003cbr> archived_uncommitted \u003cbr> archived_committed \u003cbr> archived_published\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">previousStatus\u003c/td>\n\u003ctd align=\"left\">Refers to the state the deployment was in before the last action was performed\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">lastPublishedStatus\u003c/td>\n\u003ctd align=\"left\">Refers to the state the deployment was in when it was published last\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">lastAction\u003c/td>\n\u003ctd align=\"left\">Refers to the last action that was performed on the deployment\u003c/td>\n\u003ctd align=\"left\">create \u003cbr> enable \u003cbr> disable \u003cbr> commit \u003cbr> uncommit \u003cbr> publish \u003cbr> edit \u003cbr> delete \u003cbr> undelete \u003cbr> rollback \u003cbr> merge \u003cbr> archive \u003cbr> unarchive \u003cbr>\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">executionTime\u003c/td>\n\u003ctd align=\"left\">Refers to the execution timing on the deployment.\u003cbr>This needs to be passed when you create or edit a deployment.\u003c/td>\n\u003ctd align=\"left\">immediate\u003cbr> dom_parsed (after elements exist) \u003cbr> dom_loaded (after all elements have downloaded)\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">comments\u003c/td>\n\u003ctd align=\"left\">Generic comments about the deployment\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">ruleId\u003c/td>\n\u003ctd align=\"left\">Rule Id specific to the deployment\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">labels\u003c/td>\n\u003ctd align=\"left\">Information regarding the labels associated with the deployment\u003c/td>\n\u003ctd align=\"left\">An array of labels (e.g. [{"key": "Lifecycle", "value": "prod"}])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">code\u003c/td>\n\u003ctd align=\"left\">The tag code that gets executed on deployment\u003c/td>\n\u003ctd align=\"left\">e.g. "console.log("testing app creation");"\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">dependentDeployments\u003c/td>\n\u003ctd align=\"left\">Existing deployments that are dependent\u003c/td>\n\u003ctd align=\"left\">An array of dependents (e.g. [{"deploymentId": 51658, "spaceId": 1475}])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">conditionIds\u003c/td>\n\u003ctd align=\"left\">A list of condition ids associated with the deployment\u003c/td>\n\u003ctd align=\"left\">An array of ids (e.g. [67234, 67268])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">eventIds\u003c/td>\n\u003ctd align=\"left\">A list of valid event ids associated with the deployment\u003c/td>\n\u003ctd align=\"left\">An array of ids (e.g. [1234, 456])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">creationDate\u003c/td>\n\u003ctd align=\"left\">Date the deployment was created\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">oldId\u003c/td>\n\u003ctd align=\"left\">Old deployment id from 1.0 manage system\u003c/td>\n\u003ctd align=\"left\">An integer value greater than 0 if it's migrated from 1.0 system. Otherwise, it will be NULL\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">isCreatedByApi\u003c/td>\n\u003ctd align=\"left\">Refers to the deployment that is created by api user\u003c/td>\n\u003ctd align=\"left\">1 means created by api user and 0 if it's not\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003ch2>JSON Schema\u003c/h2>\n\u003cp>Conforms to JSON schema draft v4 specifications\u003c/p>\n\u003cpre>\u003ccode>{\n    "description": "JSON Schema for deployment create request",\n    "type": "object",\n    "properties": {\n        "name": {"type": "string", "minLength": 1, "maxLength": 255},\n        "code": {"type": "string", "minLength": 1},\n        "executionTime": {\n            "type": "string",\n            "enum": ["immediate", "dom_parsed", "dom_loaded"]\n        },\n        "comments": {"type": "string"},\n        "dependentDeployments": {\n            "type": "array",\n            "minItems": 0,\n            "items": {"type": "object",\n                "properties": {\n                    "deploymentId": {"type": "number", "minimum": 0, "maximum": 2147483647},\n                    "spaceId": {"type": "number", "minimum": 0, "maximum": 2147483647}\n                },\n                "required": ["deploymentId", "spaceId"]\n            }\n        },\n        "conditionIds": {\n            "type": "array",\n            "minItems": 0,\n            "items": {"type": "number", "minimum": 0, "maximum": 2147483647},\n            "uniqueItems": true\n        }\n    },\n    "required": ["name", "code", "executionTime"]\n}\n\u003c/code>\u003c/pre>\n\u003cpre>\u003ccode>{\n    "description": "JSON Schema for deployment fetch request",\n    "type": "object",\n    "properties": {\n        "id": {"type": "number", "minimum": 0, "maximum": 2147483647},\n        "name": {"type": "string", "minLength": 1, "maxLength": 255},\n        "spaceId": {"type": "number", "minimum": 0, "maximum": 2147483647},\n        "spaceName": {"type": "string", "minLength": 1},\n        "isCustomApp": {"type": "boolean"},\n        "status": {\n            "type": "string",\n            "enum": ["disabled_uncommitted", "disabled_committed", "disabled_published", "enabled_uncommitted", "enabled_committed", "enabled_published", "deleted_uncommitted", "deleted_committed", "deleted_published", "archived_uncommitted", "archived_committed", "archived_published"]\n        },\n        "previousStatus": {\n            "type": "string",\n            "enum": ["disabled_uncommitted", "disabled_committed", "disabled_published", "enabled_uncommitted", "enabled_committed", "enabled_published", "deleted_uncommitted", "deleted_committed", "deleted_published", "archived_uncommitted", "archived_committed", "archived_published"]\n        },\n        "lastPublishedStatus": {\n            "type": "string",\n            "enum": ["disabled_uncommitted", "disabled_committed", "disabled_published", "enabled_uncommitted", "enabled_committed", "enabled_published", "deleted_uncommitted", "deleted_committed", "deleted_published", "archived_uncommitted", "archived_committed", "archived_published"]\n        },\n        "lastAction": {\n            "type": "string",\n            "enum": ["create", "enable", "disable", "commit", "uncommit", "publish", "edit", "delete", "undelete", "rollback", "merge", "archive", "unarchive"]\n        },\n        "code": {"type": "string", "minLength": 1},\n        "comments": {"type": "string", "minLength": 1},\n        "executionTime": {\n            "type": "string",\n            "enum": ["immediate", "dom_parsed", "dom_loaded"]\n        },\n        "dependentDeployments": {\n            "type": "array",\n            "minItems": 0,\n            "items": {"type": "object",\n                "properties": {\n                    "deploymentId": {"type": "number", "minimum": 0, "maximum": 2147483647},\n                    "spaceId": {"type": "number", "minimum": 0, "maximum": 2147483647}\n                },\n                "required": ["deploymentId", "spaceId"]\n            }\n        },\n        "conditionIds": {\n            "type": "array",\n            "minItems": 0,\n            "items": {"type": "number", "minimum": 0, "maximum": 2147483647},\n            "uniqueItems": true\n        },\n        "eventIds": {\n            "type": "array",\n            "minItems": 0,\n            "items": {"type": "number", "minimum": 0, "maximum": 2147483647},\n            "uniqueItems": true\n        },\n        "labels": {\n            "type": "array",\n            "minItems": 0,\n            "items": {"type": "object",\n                "properties": {\n                    "key": {"type": "string", "minLength": 1},\n                    "value": {"type": "string"}\n                }\n        },\n        "ruleId": {"type": "number", "minimum": 0, "maximum": 2147483647},\n        "vid": {"type": "number", "minimum": 0, "maximum": 2147483647},\n        "lastPublishedVid": {"type": "number", "minimum": 0, "maximum": 2147483647},\n        "appId": {"type": "number", "minimum": 0, "maximum": 2147483647},\n        "modifyDate": {"type": "string", "format": "date-time"},\n        "lastActionDate": {"type": "string", "format": "date-time"},\n        "creationDate": {"type": "string", "format": "date-time"}\n    }\n}\n\u003c/code>\u003c/pre>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/deployments{?name}{?spaceId}{?status}{?code}{?sinceCreated}{?untilCreated}{?sinceUpdated}{?untilUpdated}{?page}{?per_page}","actions":[{"name":"Get deployments","relation":"","uriTemplate":"","description":"\u003cblockquote>\n\u003cp>A request where no deployments match the query parameters returns \u003ccode>404 Not Found\u003c/code> instead of an empty array (even when the account has no deployments yet). Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"GET","parameters":[{"description":"\u003cp>Get deployments with the name.\u003c/p>\n","type":"string","required":false,"default":"","example":"mydeployment","values":[],"key":"name"},{"description":"\u003cp>get deployments in space.\u003c/p>\n","type":"string","required":false,"default":"","example":"605","values":[],"key":"spaceId"},{"description":"\u003cp>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)\u003c/p>\n","type":"string","required":false,"default":"","example":"enabled_published","values":[],"key":"status"},{"description":"\u003cp>get deployments with tag code.\u003c/p>\n","type":"string","required":false,"default":"","example":"var x = 1;","values":[],"key":"code"},{"description":"\u003cp>get deployments that were created on or after a date in GMT.\u003c/p>\n","type":"string","required":false,"default":"","example":"2013-08-07","values":[],"key":"sinceCreated"},{"description":"\u003cp>get deployments that were created before or on a date in GMT.\u003c/p>\n","type":"string","required":false,"default":"","example":"2014-08-07","values":[],"key":"untilCreated"},{"description":"\u003cp>get deployments that were updated on or after a date in GMT.\u003c/p>\n","type":"string","required":false,"default":"","example":"2014-09-07","values":[],"key":"sinceUpdated"},{"description":"\u003cp>get deployments that were updated before or on a date in GMT.\u003c/p>\n","type":"string","required":false,"default":"","example":"2014-09-07","values":[],"key":"untilUpdated"},{"description":"\u003cp>Get a specific page. Is applicable only in conjunction with the 'per_page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Limit the per page results and defaults to 10 with a maximum of 50. Is applicable only in conjunction with the 'page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[{\n    \"id\": 31126,\n    \"spaceId\": 605,\n    \"name\": \"mydeployment\",\n    \"isCustomApp\": true,\n    \"status\": \"enabled_published\",\n    \"executionTime\": \"immediate\",\n    \"comments\": \"comment for the app\",\n    \"code\": \"console.log(\\\"var x = 1;\\\");\",\n    \"dependentDeployments\": [{\"deploymentId\": 51658, \"spaceId\": 1475}],\n    \"conditionIds\": [67234, 67268],\n    \"eventIds\": [],\n    \"spaceName\": \"demo\",\n    \"appId\": 24,\n    \"appName\": \"Custom JavaScript\",\n    \"previousStatus\": \"enabled_committed\",\n    \"lastAction\": \"publish\",\n    \"ruleId\": 1165344,\n    \"labels\": [{\n          \"key\": \"Lifecycle\",\n          \"value\": \"prod\"\n    }],\n    \"modifyDate\": \"2014-09-07T17:43:48.000Z\",\n    \"lastActionDate\": \"2014-09-07T17:43:48.000Z\",\n    \"creationDate\": \"2014-08-25T17:43:48.000Z\",\n    \"lastPublishedVid\": 0\n}]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No deployments could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/deployments/search","actions":[{"name":"Search deployments","relation":"","uriTemplate":"","description":"\u003cblockquote>\n\u003cp>A search with no matching records returns \u003ccode>404 Not Found\u003c/code> instead of an empty array (even when the account has no deployments yet). Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"POST","parameters":[{"description":"\u003cp>Get the requested fields for the resulting deployments.\u003c/p>\n","type":"string","required":false,"default":"","example":"id, name, spaceId, spaceName, appName, isCustomApp, status, executionTime, lastAction, labels, ruleId, comments, dependentDeployments, conditionIds, code, creationDate, modifyDate","values":[],"key":"fields"},{"description":"\u003cp>Sort the resulting deployments by the given field name. Acceptable field names are 'name', 'appName', 'spaceName' and 'lastActionDate'. A '-' prefix indicates sort in descending order.\u003c/p>\n","type":"string","required":false,"default":"","example":"-appName","values":[],"key":"sort"},{"description":"\u003cp>Filters deployments based on the given parameters. Acceptable parameters in this object are\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>"id" (number) ... A single deployment Id.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"name" (string) ... A single deployment name.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"spaceId" (string) ... Comma-separated list of space Ids.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"publishPathId" (string) ... Comma-separated list of publish path Ids.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"eventId" (string) ... Comma-separated list of event Ids.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"labels" (object) ... List of label object keys and allowed values. Passing no values or null will filter on just the label key.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"appId" (string) ... Comma-separated list of app Ids.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"conditionId" (string) ... Comma-separated list of condition Ids. A deployment matches a condition if it\n\u003cbr>1. Directly uses the condition\n\u003cbr>2. Uses an event that requires the condition, or\n\u003cbr>3. Is in a Space that mandates the condition\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"code" (string) ... A single string to search for in the deployment's code.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"enableDisableStatus" (string) ... Array of strings that filters deployments by status using pattern matching. Can use category values like 'enabled', 'disabled', 'deleted', 'archived' to match all states in that category, or specific values like 'disabled_published', 'archived_uncommitted' to match exact states.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"live" (boolean) ... 'true' to filter for deployments enabled and published.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"includeGlobalSynchronous" (boolean) ... When \u003ccode>true\u003c/code>, deployments using the All Pages - Blocking (Synchronous) condition are included in the results. This combines with \u003ccode>conditionId\u003c/code> to produce four outcomes:\n\u003cbr>1. \u003ccode>true\u003c/code> and \u003ccode>conditionId\u003c/code> provided - returns deployments matching any of the given conditions or the All Pages - Blocking (Synchronous) condition.\n\u003cbr>2. \u003ccode>true\u003c/code> and \u003ccode>conditionId\u003c/code> omitted - returns only deployments with the All Pages - Blocking (Synchronous) condition.\n\u003cbr>3. \u003ccode>false\u003c/code>/omitted and \u003ccode>conditionId\u003c/code> provided - returns only deployments matching the given conditions, excluding the All Pages - Blocking (Synchronous) condition.\n\u003cbr>4. \u003ccode>false\u003c/code>/omitted and \u003ccode>conditionId\u003c/code> omitted - applies no condition-based filtering.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"sinceCreated" (date string) ... To get deployments that were created on or after a date in GMT, e.g. \u003ccode>2014-08-07\u003c/code>.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"untilCreated" (date string) ... To get deployments that were created before or on a date in GMT.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"sinceUpdated" (date string) ... To get deployments that were updated on or after a date in GMT.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"untilUpdated" (date string) ... To get deployments that were updated before or on a date in GMT.\u003c/p>\n\u003c/li>\n\u003c/ul>\n","type":"object","required":true,"default":"","example":"{\"spaceId\": [605],\"name\": [\"test-deploy\"]}","values":[],"key":"filters"},{"description":"\u003cp>Get a specific page. Is applicable only in conjunction with the 'per_page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Limit the per page results. Is applicable only in conjunction with the 'page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"{\n  \"fields\": \"id, spaceId, name, isCustomApp, status, executionTime, comments, code, dependentDeployments, conditionIds, labels, ruleId, creationDate\",\n  \"sort\": \"+name\",\n  \"filters\": {\n    \"spaceId\": [605],\n    \"name\": [\"test-deploy\"],\n    \"labels\": {\n        \"Lifecycle\": [\"prod\", \"stage\"] \n    }\n  }\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[{\n    \"id\": 31126,\n    \"spaceId\": 605,\n    \"name\": \"test-deploy\",\n    \"isCustomApp\": true,\n    \"status\": \"enabled_uncommitted\",\n    \"executionTime\": \"immediate\",\n    \"comments\": \"comment for the app\",\n    \"code\": \"console.log(\\\"testing app creation\\\");\",\n    \"dependentDeployments\": [{\"deploymentId\": 51658, \"spaceId\": 1475}],\n    \"conditionIds\": [67234, 67268],\n    \"labels\": [{\"key\": \"Lifecycle\", \"value\": \"prod\"}],\n    \"ruleId\": 1166344,\n    \"creationDate\": \"2013-04-25T17:43:48.000Z\"\n}]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No deployments could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/spaces/{spaceId}/deployments/{id}","actions":[{"name":"Get a deployment","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the space that this deployment is associated with.\u003c/p>\n","type":"number","required":true,"default":"","example":"605","values":[],"key":"spaceId"},{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the deployment to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"31126","values":[],"key":"id"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"    {\n        \"id\": 31126,\n        \"spaceId\": 605,\n        \"name\": \"test-deploy\",\n        \"isCustomApp\": true,\n        \"status\": \"enabled_uncommitted\",\n        \"executionTime\": \"immediate\",\n        \"comments\": \"comment for the app\",\n        \"code\": \"console.log(\\\"testing app creation\\\");\",\n        \"dependentDeployments\": [{\"deploymentId\": 51658, \"spaceId\": 1475}],\n        \"conditionIds\": [67234, 67268],\n        \"eventIds\": [],\n        \"spaceName\": \"demo\",\n        \"appId\": 24,\n        \"appName\": \"Custom JavaScript\",\n        \"previousStatus\": \"enabled_committed\",\n        \"lastAction\": \"uncommit\",\n        \"labels\": [{\n              \"key\": \"Lifecycle\",\n              \"value\": \"prod\"\n        }],\n        \"modifyDate\": \"2013-04-25T17:43:48.000Z\",\n        \"lastActionDate\": \"2013-05-25T17:43:48.000Z\",\n        \"creationDate\": \"2013-03-25T17:43:48.000Z\",\n        \"lastPublishedVid\": 0\n    }","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The deployment or space id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"The deployment could not be found.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Update a Deployment","relation":"","uriTemplate":"","description":"\u003cp>Note - Only Custom JS deployments are able to be updated through the API.\u003c/p>","method":"PUT","parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the space that this deployment is associated with.\u003c/p>\n","type":"number","required":true,"default":"","example":"605","values":[],"key":"spaceId"},{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the deployment to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"31126","values":[],"key":"id"}],"headers":{},"examples":[{"requests":[{"body":"{\n    \"name\": \"test-deploy\",\n    \"executionTime\": \"immediate\",\n    \"comments\": \"comment for the app\",\n    \"code\": \"console.log(\\\"testing app creation\\\");\",\n    \"dependentDeployments\": [{\"deploymentId\": 51658, \"spaceId\": 1475}],\n    \"conditionIds\": [67234, 67268]\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01..."},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The deployment or space id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"Unable to find space with space id - 111111\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Delete a Deployment","relation":"","uriTemplate":"","description":"","method":"DELETE","parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the space that this deployment is associated with.\u003c/p>\n","type":"number","required":true,"default":"","example":"605","values":[],"key":"spaceId"},{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the deployment to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"31126","values":[],"key":"id"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01..."},"headers1A":[{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The deployment or space id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"Unable to find deployment with deployment id - 111111\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/spaces/{spaceId}/deployments","actions":[{"name":"Create a deployment","relation":"","uriTemplate":"","description":"\u003cp>Note - Only Custom JS deployments are able to be created through the API.\u003c/p>","method":"POST","parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the space that this deployment is associated with.\u003c/p>\n","type":"number","required":true,"default":"","example":"","values":[],"key":"spaceId"}],"headers":{},"examples":[{"requests":[{"body":"{\n    \"name\": \"test-deploy\",\n    \"executionTime\": \"immediate\",\n    \"comments\": \"comment for the app\",\n    \"code\": \"console.log(\\\"testing app creation\\\");\",\n    \"dependentDeployments\": [{\"deploymentId\": 51658, \"spaceId\": 1475}],\n    \"conditionIds\": [67234, 67268],\n    \"labels\": [{\n          \"key\": \"Lifecycle\",\n          \"value\": \"prod\"\n    }]\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 31126,\n    \"spaceId\": 605,\n    \"name\": \"test-deploy\",\n    \"isCustomApp\": true,\n    \"status\": \"enabled_uncommitted\",\n    \"executionTime\": \"immediate\",\n    \"comments\": \"comment for the app\",\n    \"code\": \"console.log(\\\"testing app creation\\\");\",\n    \"dependentDeployments\": [{\"deploymentId\": 51658, \"spaceId\": 1475}],\n    \"conditionIds\": [67234, 67268],\n     \"labels\": [{\n          \"key\": \"Lifecycle\",\n          \"value\": \"prod\"\n    }]\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The space id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The deployment could not be created with the given criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the space id to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"605","values":[],"key":"spaceId"},{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the deployment to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"31126","values":[],"key":"id"},{"description":"\u003cp>String value to indicate if its an enable, disable, commit, uncommit, undelete, archive, or unarchive operation.\u003c/p>\n","type":"string","required":true,"default":"","example":"enable","values":[],"key":"action"}],"uriTemplate":"/manage/spaces/{spaceId}/deployments/{id}/{action}","actions":[{"name":"Enable / Disable / Commit / Uncommit / Undelete / Archive / Unarchive a Deployment","relation":"","uriTemplate":"","description":"","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"spaceId\": 5511,\n    \"commitId\": \"123\",\n    \"requestedDate\": \"2024-01-01 12:34:56\",\n    \"deploymentId\": 68000\n}\n","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The deployment or space id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"Deployment is locked\"\n}","schema":"","description":"\u003cp>Returned when the deployment is locked and cannot be modified.\u003c/p>","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>String value to indicate if its a batch commit or uncommit operation.\u003c/p>\n","type":"string","required":true,"default":"","example":"commit","values":[],"key":"action"}],"uriTemplate":"/manage/spaces/deployments/batch/{action}","actions":[{"name":"Commit / Uncommit Deployments","relation":"","uriTemplate":"","description":"","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"    {\n        \"deploymentIds\": [61367, 61368],\n        \"spaceIds\": [6020, 6020]\n    }","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\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}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/spaces/{spaceId}/deployments/{id}/merge/{targetSpaceId}","actions":[{"name":"Merge","relation":"","uriTemplate":"","description":"","method":"PUT","parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the space that this deployment is associated with.\u003c/p>\n","type":"number","required":true,"default":"","example":"605","values":[],"key":"spaceId"},{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the deployment to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"31126","values":[],"key":"id"},{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the target space that this deployment is to be merged into.\u003c/p>\n","type":"number","required":true,"default":"","example":"706","values":[],"key":"targetSpaceId"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01..."},"headers1A":[{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"}],"name":"","description":""}]}],"description":""}]},{"name":"Conditions","description":"\u003cp>CRUD operations with \u003cstrong>Conditions\u003c/strong>.\u003c/p>\n\u003ch2>Important Condition specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">id\u003c/td>\n\u003ctd align=\"left\">The condition id\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">name\u003c/td>\n\u003ctd align=\"left\">The name of the condition\u003c/td>\n\u003ctd align=\"left\">A name up to 255 characters\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">conditionValues\u003c/td>\n\u003ctd align=\"left\">Criteria used to define and configure the condition\u003c/td>\n\u003ctd align=\"left\">\u003cem>(More information below)\u003c/em>\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">mandatedInSpaces\u003c/td>\n\u003ctd align=\"left\">Spaces where this condition is mandated\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">deployments\u003c/td>\n\u003ctd align=\"left\">Deployments that are associated with this condition\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">labels\u003c/td>\n\u003ctd align=\"left\">Information regarding the labels associated with the condition\u003c/td>\n\u003ctd align=\"left\">An array of labels (e.g. [{"key": "Lifecycle", "value": "prod"}])\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003ch2>Condition-value specific fields\u003c/h2>\n\u003cp>A condition can have one or more condition-values, each of which is defined as an object with the following (required) properties \u003cbr>\u003c/p>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">typeId\u003c/td>\n\u003ctd align=\"left\">Indicates the type of the condition parameter\u003c/td>\n\u003ctd align=\"left\">2 (Host)\u003cbr> 4 (Path)\u003cbr> 7 (Protocol)\u003cbr> 10 (Query Pair)\u003cbr> 11 (Hash Fragment)\u003cbr> 16 (Platform)\u003cbr> 18 (DateTime)\u003cbr> 19 (Geocode)\u003cbr> 20 (IP Address)\u003cbr> 26 (Browser)\u003cbr> 27 (Do Not Track)\u003cbr> 28 (Date Recurrence)\u003cbr> 30 (Data Definition)\u003cbr> 31 (Query Param)\u003cbr> 32 (Query Value)\u003cbr> 33 (Test URLs)\u003cbr> 35 (Threat Type)\u003cbr>\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">value\u003c/td>\n\u003ctd align=\"left\">Indicates the value for the condition (as a string)\u003c/td>\n\u003ctd align=\"left\">see examples below\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">comparatorId\u003c/td>\n\u003ctd align=\"left\">Indicates the comparator to use for mapping the type to value\u003c/td>\n\u003ctd align=\"left\">\u003cstrong>For Threat Type (typeId: 35)\u003c/strong>\u003cul>\u003cli>34 (include) - Matches any selected Threat Type(s)\u003c/li>\u003cli>35 (exclude) - Does not match any selected Threat Type(s)\u003c/li>\u003cli>36 (include all) - Matches all selected Threat Type(s)\u003c/li>\u003cli>37 (exclude all) - Does not match all selected Threat Type(s)\u003c/li>\u003cli>38 (include exact) - Matches exactly the selected Threat Type(s)\u003c/li>\u003cli>39 (exclude exact) - Does not match exactly the selected Threat Type(s)\u003c/li>\u003c/ul>\u003cbr>\u003cstrong>For Date Recurrence (typeId: 28)\u003c/strong>\u003cul>\u003cli>28 (is in list)\u003c/li>\u003cli>With the list as numbers with the mapping 0=Sunday, 1=Monday and so on\u003c/li>\u003c/ul>\u003cbr>\u003cstrong>For Browser (typeId: 26)\u003c/strong>\u003cul>\u003cli>26 (is in list)\u003c/li>\u003c/ul>\u003cbr>\u003cstrong>For Do Not Track (typeId: 27)\u003c/strong>\u003cul>\u003cli>27 (is)\u003c/li>\u003cli>With the value being 'T' or 'F' to indicate True or False\u003c/li>\u003c/ul>\u003cbr>\u003cstrong>For IP Address (typeId: 20)\u003c/strong>\u003cul>\u003cli>16 (equals)\u003c/li>\u003cli>17 (is greater than)\u003c/li>\u003cli>18 (is less than)\u003c/li>\u003c/ul>\u003cbr>\u003cstrong>For Geocode (typeId: 19)\u003c/strong>\u003cul>\u003cli>15 (is in list)\u003c/li>\u003c/ul>\u003cbr>\u003cstrong>For DateTime (typeId: 18)\u003c/strong>\u003cul>\u003cli>12 (is before)\u003c/li>\u003cli>13 (is after)\u003c/li>\u003c/ul>\u003cbr>\u003cstrong>For Platform (typeId: 16)\u003c/strong>\u003cul>\u003cli>14 (is in list)\u003c/li>\u003c/ul>\u003cbr>\u003cstrong>For All Other Types\u003c/strong>\u003cul>\u003cli>0 (No-op)\u003c/li>\u003cli>1 (Equals)\u003c/li>\u003cli>2 (Contains)\u003c/li>\u003cli>3 (Matches RegEx)\u003c/li>\u003cli>4 (Begins with)\u003c/li>\u003cli>5 (Ends with)\u003c/li>\u003c/ul>\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">modifierIds\u003c/td>\n\u003ctd align=\"left\">Indicates the modifiers to use on the values\u003c/td>\n\u003ctd align=\"left\">There are only two acceptable values:\u003cbr> 1 (negation/not), 2 (ignore case)\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003cp>For example, for condition value which host contains test.com or TEST.COM or Test.com would be:\u003c/p>\n\u003cpre>\u003ccode>    {\n        "typeId": 2,\n        "value": "test.com",\n        "comparatorId": 2,\n        "modifierIds": [2]\n    }\n\u003c/code>\u003c/pre>\n\u003cp>And for condition value which host does not contain test.com would be:\u003c/p>\n\u003cpre>\u003ccode>    {\n        "typeId": 2,\n        "value": "test.com",\n        "comparatorId": 2,\n        "modifierIds": [1]\n    }\n\u003c/code>\u003c/pre>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/conditions/search","actions":[{"name":"Search Conditions","relation":"","uriTemplate":"","description":"\u003cblockquote>\n\u003cp>A search with no matching records returns \u003ccode>404 Not Found\u003c/code> instead of an empty array (even when the account has no conditions yet). Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"POST","parameters":[{"description":"\u003cp>Get the requested fields for the resulting conditions.\u003c/p>\n","type":"string","required":false,"default":"","example":"id, name, creationDate, modifyDate, spaceId, spaceName, conditionValues, labels, deployments, mandatedInSpaces","values":[],"key":"fields"},{"description":"\u003cp>Sort the resulting conditions by the given field name. Acceptable field names are 'name', 'modifyDate', 'spaceName' or 'creationDate'. A '-' prefix indicates sort in descending order.\u003c/p>\n","type":"string","required":false,"default":"","example":"-name","values":[],"key":"sort"},{"description":"\u003cp>Filters conditions based on the given parameters. Acceptable parameters in this object are\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>"id" (comma-separated list of condition ids)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"name" (comma-separated list of condition names)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"labels" (list of label object keys and allowed values. Passing no values or null will filter on just the label key.)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"inUse" (boolean. If true, will filter for conditions that are in use in deployments, events, data definitions, or spaces. If false, will filter for conditions that are NOT in use)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"dataDefNames" (comma-separated list of data definition names that are associated with a condition)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"eventNames" (comma-separated list of event names that are associated with a condition)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"spaceId" (comma-separated list of space ids that conditions are in those spaces, \u003ccode>-1\u003c/code> means global space)\u003c/p>\n\u003c/li>\n\u003c/ul>\n","type":"object","required":true,"default":"","example":"","values":[],"key":"filters"},{"description":"\u003cp>Get a specific page. Is applicable only in conjunction with the 'per_page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Limit the per page results. Is applicable only in conjunction with the 'page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"{\n    \"fields\": \"id, name, conditionValues, modifyDate, creationDate\",\n    \"sort\": \"+name\",\n    \"filters\": {\n        \"spaceId\": [67250, -1],\n        \"labels\": {\n            \"Lifecycle\": [\"prod\", \"stage\"]\n        },\n        \"eventNames\": [\"event1\"],\n        \"dataDefNames\": [\"dataDef1\"]\n    }\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[{\n    \"id\": 647250,\n    \"name\": \"Checkout Condition\",\n    \"conditionValues\": [\n        {\n            \"typeId\": 7,\n            \"value\": \"https?\",\n            \"comparatorId\": 3,\n            \"modifierIds\": []\n        }\n    ],\n    \"modifyDate\": \"2013-04-25T17:43:48.000Z\",\n    \"creationDate\": \"2013-04-25T17:43:48.000Z\",\n    \"spaceId\": -1,\n    \"spaceName\": \"Global\",\n    \"labels\": [{\n        \"key\": \"Lifecycle\",\n        \"value\": \"prod\"\n    }],\n    \"mandatedInSpaces\": [\n        {\n            \"id\": 1,\n            \"name\": \"dev\"\n        },\n        {\n            \"id\": 2,\n            \"name\": \"stage\"\n        }\n    ],\n    \"deployments\": [\n        {\n            \"spaceId\": 1,\n            \"spaceName\": \"dev\",\n            \"id\": 2,\n            \"name\": \"Sample Deployment\"\n        }\n    ]\n}]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No conditions could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/conditions/{id}","actions":[{"name":"Get a condition by id","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the condition to perform the action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"1","values":[],"key":"id"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 67250,\n    \"name\": \"Checkout Condition\",\n    \"conditionValues\": [{\n        \"typeId\": 7,\n        \"comparatorId\": 3,\n        \"value\": \"https?\",\n        \"modifierIds\": []\n    }, {\n        \"typeId\": 2,\n        \"comparatorId\": 3,\n        \"value\": \"^(highres\\\\.io)$\",\n        \"modifierIds\": [1, 2]\n    }, {\n        \"typeId\": 11,\n        \"comparatorId\": 3,\n        \"value\": \"^()$\",\n        \"modifierIds\": [1]\n    }, {\n        \"typeId\": 4,\n        \"comparatorId\": 3,\n        \"value\": \"^(/demo)$\",\n        \"modifierIds\": []\n    }, {\n        \"typeId\": 30,\n        \"comparatorId\": 2,\n        \"dataDefId\": 1750,\n        \"value\": \"999\",\n        \"modifierIds\": [2]\n    }],\n    \"labels\": [{\n          \"key\": \"Lifecycle\",\n          \"value\": \"prod\"\n    }],\n    \"mandatedInSpaces\": [{\n        \"id\": 4076,\n        \"name\": \"NewMerchants\"\n    },{\n        \"id\": 12864,\n        \"name\": \"Demo\"\n    }],\n    \"deployments\": [{\n        \"spaceId\": 14909,\n        \"spaceName\": \"Archives\",\n        \"id\": 360117,\n        \"name\": \"ProductLaunch\"\n    }, {\n        \"spaceId\": 5572,\n        \"spaceName\": \"chrome\",\n        \"id\": 343809,\n        \"name\": \"VisualConfirmation\"\n    }]\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The condition id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No conditions could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Update / Edit a condition","relation":"","uriTemplate":"","description":"","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n  \"name\": \"Checkout Condition\",\n  \"conditionValues\": [\n    {\n      \"typeId\": 7,\n      \"value\": \"https?\",\n      \"comparatorId\": 3,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 2,\n      \"value\": \"^(google\\\\.com)$\",\n      \"comparatorId\": 3,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 4,\n      \"value\": \"^(/finance)$\",\n      \"comparatorId\": 3,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 11,\n      \"value\": \"^()$\",\n      \"comparatorId\": 3,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 33,\n      \"value\": \"google.com\",\n      \"comparatorId\": 0,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 10,\n      \"comparatorId\": 0,\n      \"modifierIds\": [],\n      \"queryParam\": {\n        \"value\": \"^q$\",\n        \"modifierIds\": [],\n        \"comparatorId\": 3\n      },\n      \"queryValue\": {\n        \"name\": \"Query Value\",\n        \"value\": \"^(goog)$\",\n        \"modifierIds\": [],\n        \"comparatorId\": 3\n      }\n    },\n    {\n      \"typeId\": 19,\n      \"value\": \"IN,US\",\n      \"comparatorId\": 1,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 18,\n      \"value\": \"2014-04-14T00:00:00.000Z\",\n      \"comparatorId\": 13,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 18,\n      \"value\": \"2014-04-18T21:00:00.000Z\",\n      \"comparatorId\": 12,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 28,\n      \"value\": \"0,2,4,6\",\n      \"comparatorId\": 1,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 20,\n      \"value\": \"10.0.1.5\",\n      \"comparatorId\": 16,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 20,\n      \"value\": \"10.0.1.1\",\n      \"comparatorId\": 17,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 20,\n      \"value\": \"10.0.1.23\",\n      \"comparatorId\": 18,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 26,\n      \"value\": \"Firefox,Opera\",\n      \"comparatorId\": 1,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 16,\n      \"value\": \"OSX,Linux\",\n      \"comparatorId\": 1,\n      \"modifierIds\": []\n    }\n  ],\n  \"spaceIds\": [\n    12345\n  ]\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01..."},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The condition id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 403,\n    \"message\": \"Forbidden\",\n    \"description\": \"Access is denied\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"403"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"The condition could not be found\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Delete a condition","relation":"","uriTemplate":"","description":"","method":"DELETE","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01..."},"headers1A":[{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The condition id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 403,\n    \"message\": \"Forbidden\",\n    \"description\": \"Access is denied\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"403"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"condition with id - 9999999 could not be deleted - this condition does not exist\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/conditions","actions":[{"name":"Create a condition","relation":"","uriTemplate":"","description":"","method":"POST","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n  \"name\": \"A brand new condition\",\n  \"conditionValues\": [\n    {\n      \"typeId\": 7,\n      \"value\": \"https?\",\n      \"comparatorId\": 3,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 2,\n      \"value\": \"^(google\\\\.com)$\",\n      \"comparatorId\": 3,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 4,\n      \"value\": \"^(/finance)$\",\n      \"comparatorId\": 3,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 11,\n      \"value\": \"^()$\",\n      \"comparatorId\": 3,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 33,\n      \"value\": \"google.com\",\n      \"comparatorId\": 0,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 10,\n      \"comparatorId\": 0,\n      \"modifierIds\": [],\n      \"queryParam\": {\n        \"value\": \"^q$\",\n        \"modifierIds\": [],\n        \"comparatorId\": 3\n      },\n      \"queryValue\": {\n        \"value\": \"^(goog)$\",\n        \"modifierIds\": [],\n        \"comparatorId\": 3\n      }\n    },\n    {\n      \"typeId\": 19,\n      \"value\": \"IN,US\",\n      \"comparatorId\": 1,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 18,\n      \"value\": \"2014-04-14T00:00:00.000Z\",\n      \"comparatorId\": 13,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 18,\n      \"value\": \"2014-04-18T21:00:00.000Z\",\n      \"comparatorId\": 12,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 28,\n      \"value\": \"0,2,4,6\",\n      \"comparatorId\": 1,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 20,\n      \"value\": \"10.0.1.5\",\n      \"comparatorId\": 16,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 20,\n      \"value\": \"10.0.1.1\",\n      \"comparatorId\": 17,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 20,\n      \"value\": \"10.0.1.23\",\n      \"comparatorId\": 18,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 26,\n      \"value\": \"Firefox,Opera\",\n      \"comparatorId\": 1,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 16,\n      \"value\": \"OSX,Linux\",\n      \"comparatorId\": 1,\n      \"modifierIds\": []\n    },\n    {\n      \"typeId\": 30,\n      \"comparatorId\": 2,\n      \"dataDefId\": 1750,\n      \"value\": \"999\",\n      \"modifierIds\": [\n        2\n      ]\n    }\n  ],\n  \"spaceIds\": [\n    12345\n  ],\n  \"labels\": [\n    {\n      \"key\": \"Lifecycle\",\n      \"value\": \"prod\"\n    }\n  ]\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 9821\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 403,\n    \"message\": \"Forbidden\",\n    \"description\": \"Access is denied\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"403"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/space/{spaceId}/conditions","actions":[{"name":"Get space conditions","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[{"description":"\u003cp>Numeric \u003ccode>spaceId\u003c/code> of the space to perform the action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"1","values":[],"key":"spaceId"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[\n  {\n    \"id\": 67250,\n    \"name\": \"Checkout Condition\",\n    \"conditionValues\": [\n      {\n        \"typeId\": 7,\n        \"comparatorId\": 3,\n        \"value\": \"https?\",\n        \"modifierIds\": []\n      },\n      {\n        \"typeId\": 2,\n        \"comparatorId\": 3,\n        \"value\": \"^(highres\\\\.io)$\",\n        \"modifierIds\": [\n          1,\n          2\n        ]\n      },\n      {\n        \"typeId\": 11,\n        \"comparatorId\": 3,\n        \"value\": \"^()$\",\n        \"modifierIds\": [\n          1\n        ]\n      },\n      {\n        \"typeId\": 4,\n        \"comparatorId\": 3,\n        \"value\": \"^(/demo)$\",\n        \"modifierIds\": []\n      },\n      {\n        \"typeId\": 30,\n        \"comparatorId\": 2,\n        \"dataDefId\": 1750,\n        \"value\": \"999\",\n        \"modifierIds\": [\n          2\n        ]\n      }\n    ],\n    \"labels\": [\n      {\n        \"key\": \"Lifecycle\",\n        \"value\": \"prod\"\n      }\n    ],\n    \"mandatedInSpaces\": [\n      {\n        \"id\": 4076,\n        \"name\": \"NewMerchants\"\n      },\n      {\n        \"id\": 12864,\n        \"name\": \"Demo\"\n      }\n    ],\n    \"deployments\": [\n      {\n        \"spaceId\": 14909,\n        \"spaceName\": \"Archives\",\n        \"id\": 360117,\n        \"name\": \"ProductLaunch\"\n      },\n      {\n        \"spaceId\": 5572,\n        \"spaceName\": \"chrome\",\n        \"id\": 343809,\n        \"name\": \"VisualConfirmation\"\n      }\n    ]\n  }\n]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]}],"description":""}]},{"name":"Data Definitions","description":"\u003cp>CRUD operations with \u003cstrong>Data Definitions\u003c/strong>.\u003c/p>\n\u003ch2>Data Definitions specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Required\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">name\u003c/td>\n\u003ctd align=\"left\">Y\u003c/td>\n\u003ctd align=\"left\">The name of the definition\u003c/td>\n\u003ctd align=\"left\">A name up to 255 characters\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">collection\u003c/td>\n\u003ctd align=\"left\">Y\u003c/td>\n\u003ctd align=\"left\">The name for a collection of definitions\u003c/td>\n\u003ctd align=\"left\">A name up to 255 characters\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">source\u003c/td>\n\u003ctd align=\"left\">Y\u003c/td>\n\u003ctd align=\"left\">The source of the definition\u003c/td>\n\u003ctd align=\"left\">Accepted values are: \u003cbr> Manage \u003cbr> Mobile \u003cbr> Pulse \u003cbr> One \u003cbr> Attribution \u003cbr> Inform \u003cbr> Privacy\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">extractor\u003c/td>\n\u003ctd align=\"left\">Y\u003c/td>\n\u003ctd align=\"left\">Javascript code for extraction\u003c/td>\n\u003ctd align=\"left\">Must be a valid Javascript function. e.g. function(){try{return Bootstrapper.data.extract('ec','cookie')}catch(e){return 'error'}}\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">description\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">A description\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">enabled\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Is the definition enabled\u003c/td>\n\u003ctd align=\"left\">A boolean value\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">persistence\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Indicates the persistence type\u003c/td>\n\u003ctd align=\"left\">Defaults to "page" if none provided \u003cbr> Accepted values are: \u003cbr> instance \u003cbr> page \u003cbr> session \u003cbr> visitor\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">metaDesc\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Indicates the comparator to use for mapping the type to value\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">transformation\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Javascript code for transformation of the data\u003c/td>\n\u003ctd align=\"left\">Must be a valid Javascript function. e.g. function(value) { return value; }\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">trigger\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Javascript code that is used to trigger an event\u003c/td>\n\u003ctd align=\"left\">Defaults to "Bootstrapper.data.bottomOfBodyTrigger" if none provided\u003cbr> Accepted values are: \u003cbr> A valid Javascript function. e.g. function() { return 'foo';} \u003cbr> Bootstrapper.data.bottomOfBodyTrigger \u003cbr> Bootstrapper.data.afterEnsightenCompleteTrigger \u003cbr> Bootstrapper.data.afterElementsDownloadedTrigger \u003cbr>\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">criteriaIds\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">A list of valid condition ids to add as conditions on this data definition\u003c/td>\n\u003ctd align=\"left\">An array of ids (e.g. [100, 101])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">conditionIds\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Read-only. A list of condition ids that use this data definition\u003c/td>\n\u003ctd align=\"left\">An array of ids (e.g. [100, 101])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">spaceIds\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">A list of valid space ids to associate with the definition\u003c/td>\n\u003ctd align=\"left\">An array of ids (e.g. [100, 101])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">fromType\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Indicates the type where the data is from\u003c/td>\n\u003ctd align=\"left\">Accepted values are: \u003cbr> 1 - First Party Cookie \u003cbr> 2 - Query Parameter \u003cbr> 3 - Metadata Tag \u003cbr> 4 - JavaScript Variable \u003cbr> 5 - Web Page Element \u003cbr> 6 - Custom\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">fromName\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Indicates the name where the data is from\u003c/td>\n\u003ctd align=\"left\">A string value\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">fromSource\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">Indicates the source where the data is from\u003c/td>\n\u003ctd align=\"left\">Accepted values are: \u003cbr> 1 - Text Value \u003cbr> 2 - HTML Value \u003cbr> 3 - Outer HTML\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">labels\u003c/td>\n\u003ctd align=\"left\">N\u003c/td>\n\u003ctd align=\"left\">A list of key/value label pairs to associate with this data definition\u003c/td>\n\u003ctd align=\"left\">An array of objects (e.g. \u003ccode>[{"key": "Lifecycle", "value": "prod"}]\u003c/code>)\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/datadefinitions/search","actions":[{"name":"Search Data Definitions","relation":"","uriTemplate":"","description":"\u003cblockquote>\n\u003cp>A search with no matching records returns \u003ccode>404 Not Found\u003c/code> instead of an empty array (even when the account has no data definitions yet). Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"POST","parameters":[{"description":"\u003cp>Get the requested fields for the resulting data definitions.\u003c/p>\n","type":"string","required":false,"default":"","example":"id, name, labels","values":[],"key":"fields"},{"description":"\u003cp>Sort the resulting data definitions by the given field name. Acceptable field names are 'name', 'collections', 'source', 'enabled', or 'creationDate'. A '-' prefix indicates sort in descending order.\u003c/p>\n","type":"string","required":false,"default":"","example":"-name","values":[],"key":"sort"},{"description":"\u003cp>Filters data definitions based on the given parameters. Acceptable parameters in this object are\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>"id" (array) ... Array of data definition ids.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"name" (array) ... Array of data definition names.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"collection" (array) ... Array of data definitions collections.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"criteriaId" (array) ... Array of condition Ids associated with a data definition. When provided, only data definitions associated with one or more of the specified conditions are returned. The default All Pages - Blocking (Synchronous) condition cannot be used as a filter value.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"spaceId" (array) ... Array of space Ids that are associated with a data definition.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"isEnabled" (boolean) ... If true, will filter for data definitions that are enabled. If false, will filter for data definitions that are NOT enabled.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"code" (string) ... A single string to search for in the data definition's transformer, extractor and trigger's code.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"labels" (object) ... List of label object keys and allowed values. Passing no values or null will filter on just the label key.\u003c/p>\n\u003c/li>\n\u003c/ul>\n","type":"object","required":true,"default":"","example":"{\"id\": [67250],\"criteriaId\": [444]}","values":[],"key":"filters"},{"description":"\u003cp>Get a specific page. Is applicable only in conjunction with the 'per_page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Limit the per page results. Is applicable only in conjunction with the 'page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"{\n  \"fields\": \"id, name, source, collection, enabled, criteriaIds, conditionIds, spaceIds, creationDate, labels\",\n  \"sort\": \"+name\",\n  \"filters\": {\n    \"collection\": [\"PixelCollection\"],\n    \"criteriaId\": [444],\n    \"labels\": {\n      \"Lifecycle\": [\"prod\", \"stage\"]\n    }\n  }\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[{\n    \"id\": 273,\n    \"name\": \"vl\",\n    \"collection\": \"PixelCollection\",\n    \"source\": \"Pulse\",\n    \"enabled\": false,\n    \"extractor\": \"function(){try{return Bootstrapper.data.extract('vl','cookie')}catch(e){return 'error'}}\",\n    \"criteriaIds\": [100, 101],\n    \"conditionIds\": [444],\n    \"spaceIds\": [ ],\n    \"creationDate\": \"2014-02-12T03:53:57.000Z\",\n    \"fromType\": 1,\n    \"fromName\": \"cookieName\",\n    \"fromSource\": 1,\n    \"labels\": [{\"key\": \"Lifecycle\", \"value\": \"prod\"}]\n}]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No data definitions could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the data definition id to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"1","values":[],"key":"id"}],"uriTemplate":"/manage/datadefinitions/{id}","actions":[{"name":"Get a data definition by id","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 273,\n    \"name\": \"vl\",\n    \"collection\": \"PixelCollection\",\n    \"source\": \"Pulse\",\n    \"description\": \"\",\n    \"enabled\": false,\n    \"persistence\": \"page\",\n    \"metaDesc\": {},\n    \"extractor\": \"function(){try{return Bootstrapper.data.extract('vl','cookie')}catch(e){return 'error'}}\",\n    \"transformation\": \"\",\n    \"trigger\": \"Bootstrapper.data.bottomOfBodyTrigger\",\n    \"criteriaIds\": [100, 101],\n    \"conditionIds\": [ ],\n    \"spaceIds\": [ ],\n    \"creationDate\": \"2014-02-12T03:53:57.000Z\",\n    \"fromType\": 1,\n    \"fromName\": \"cookieName\",\n    \"fromSource\": 1,\n    \"labels\": [{\n      \"key\": \"Lifecycle\",\n      \"value\": \"prod\"\n    }]\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The data definition id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"The data definitions could not be found.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Delete a data definition","relation":"","uriTemplate":"","description":"","method":"DELETE","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01..."},"headers1A":[{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The data definition id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 403,\n    \"message\": \"Forbidden\",\n    \"description\": \"The requester does not have permission to make this request.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"403"}],"name":"","description":""}]},{"name":"Update a data definition","relation":"","uriTemplate":"","description":"\u003cp>See the documentation above on \u003cstrong>Data Definitions specific fields\u003c/strong> for more information on what to provide.\nUpdating a Data Definition will not affect its state.\u003c/p>","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"id\": 123,\n    \"name\": \"vl2\",\n    \"collection\": \"PixelCollection\",\n    \"source\": \"Pulse\",\n    \"persistence\": \"session\",\n    \"extractor\": \"function(){try{return Bootstrapper.data.extract('vl2','cookie')}catch(e){return 'error'}}\",\n    \"criteriaIds\": [100, 101],\n    \"fromType\": 1,\n    \"fromName\": \"cookieName\",\n    \"fromSource\": 1\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01..."},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The data definition id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 403,\n    \"message\": \"Forbidden\",\n    \"description\": \"The requester does not have permission to make this request.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"403"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/datadefinitions","actions":[{"name":"Create a data definition","relation":"","uriTemplate":"","description":"","method":"POST","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"name\": \"vl2\",\n    \"collection\": \"PixelCollection\",\n    \"source\": \"Pulse\",\n    \"persistence\": \"session\",\n    \"extractor\": \"function(){try{return Bootstrapper.data.extract('vl2','cookie')}catch(e){return 'error'}}\",\n    \"criteriaIds\": [100, 101],\n    \"fromType\": 1,\n    \"fromName\": \"cookieName\",\n    \"fromSource\": 1,\n    \"labels\": [{\n      \"key\": \"Lifecycle\",\n      \"value\": \"prod\"\n    }]\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01..."},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 273,\n    \"name\": \"vl2\",\n    \"collection\": \"PixelCollection\",\n    \"source\": \"Pulse\",\n    \"description\": \"\",\n    \"enabled\": false,\n    \"persistence\": \"session\",\n    \"metaDesc\": {},\n    \"extractor\": \"function(){try{return Bootstrapper.data.extract('vl2','cookie')}catch(e){return 'error'}}\",\n    \"transformation\": \"\",\n    \"trigger\": \"Bootstrapper.data.bottomOfBodyTrigger\",\n    \"criteriaIds\": [100, 101],\n    \"conditionIds\": [ ],\n    \"spaceIds\": [ ],\n     \"labels\": [{\n       \"key\": \"Lifecycle\",\n        \"value\": \"prod\"\n    }],\n    \"creationDate\": \"2014-02-12T03:53:57.000Z\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 403,\n    \"message\": \"Forbidden\",\n    \"description\": \"The requester does not have permission to make this request.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"403"}],"name":"","description":""}]}],"description":"\u003cp>When creating a data definition, "source", "collection", "name", and "extractor" are required fields. See the documentation above\non \u003cstrong>Data Definitions specific fields\u003c/strong> for more information on what to provide.\nAll Data Definitions will be in a "disabled" state when created.\u003c/p>"},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the data definition to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"273","values":[],"key":"id"},{"description":"\u003cp>String value to indicate if its an enable or a disable\u003c/p>\n","type":"string","required":true,"default":"","example":"enable","values":[],"key":"action"}],"uriTemplate":"/manage/datadefinitions/{id}/{action}","actions":[{"name":"Enable / Disable a Data Definition","relation":"","uriTemplate":"","description":"","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01..."},"headers1A":[{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The data definition id or action is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 403,\n    \"message\": \"Forbidden\",\n    \"description\": \"The requester does not have permission to make this request.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"403"}],"name":"","description":""}]}],"description":""}]},{"name":"Event Definitions","description":"\u003cp>CRUD operations with \u003cstrong>Event Definitions\u003c/strong>.\u003c/p>\n\u003ch2>Event Definition specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">name\u003c/td>\n\u003ctd align=\"left\">The name of the definition\u003c/td>\n\u003ctd align=\"left\">A name up to 255 characters\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">type\u003c/td>\n\u003ctd align=\"left\">Indicates the type of the event definition\u003c/td>\n\u003ctd align=\"left\">page_action \u003cbr> data \u003cbr> named\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">conditionIds\u003c/td>\n\u003ctd align=\"left\">A list of valid condition ids to associate with the event\u003c/td>\n\u003ctd align=\"left\">An array of ids (e.g. [100, 101])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">elementType\u003c/td>\n\u003ctd align=\"left\">Indicates the element type\u003c/td>\n\u003ctd align=\"left\">css_selector \u003cbr> element_id \u003cbr> element_class \u003cbr> javascript\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">trigger\u003c/td>\n\u003ctd align=\"left\">Indicates what action should trigger the event\u003c/td>\n\u003ctd align=\"left\">click \u003cbr> mousedown \u003cbr> mouseup \u003cbr> mouseover \u003cbr> mouseout \u003cbr> mousemove \u003cbr> contextmenu \u003cbr> dblclick\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">data\u003c/td>\n\u003ctd align=\"left\">Data to associate with a page action event\u003c/td>\n\u003ctd align=\"left\">e.g. "a.add-to-cart"\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">dataDefinitionId\u003c/td>\n\u003ctd align=\"left\">The id for a valid data definition\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">labels\u003c/td>\n\u003ctd align=\"left\">Information regarding the labels associated with the event\u003c/td>\n\u003ctd align=\"left\">An array of labels (e.g. [{"key": "Lifecycle", "value": "prod"}])\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003ch2>Event Definition types and allowed fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">TypeId\u003c/th>\n\u003cth align=\"left\">Type\u003c/th>\n\u003cth align=\"left\">Allowed Fields\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">0\u003c/td>\n\u003ctd align=\"left\">page_action\u003c/td>\n\u003ctd align=\"left\">name \u003cbr> type \u003cbr> conditionIds \u003cbr> elementType \u003cbr> data \u003cbr> trigger \u003cbr> fastBinding \u003cbr> allowIncompleteCalls \u003cbr> labels\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">1\u003c/td>\n\u003ctd align=\"left\">data\u003c/td>\n\u003ctd align=\"left\">name \u003cbr> type \u003cbr> conditionIds \u003cbr> dataDefinitionId \u003cbr> fireWhenFirstSet \u003cbr> fireWhenValueUpdated \u003cbr> labels\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">2\u003c/td>\n\u003ctd align=\"left\">named\u003c/td>\n\u003ctd align=\"left\">name \u003cbr> type \u003cbr> conditionIds \u003cbr> labels\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/events{?name}{?type}{?page}{?per_page}","actions":[{"name":"Search event definitions","relation":"","uriTemplate":"","description":"\u003cp>\u003cstrong>[DEPRECATED]\u003c/strong> API endpoint to search event definitions was moved to \u003ccode>/manage/events/search\u003c/code>.\u003c/p>\n\u003cblockquote>\n\u003cp>A search with no matching records returns \u003ccode>404 Not Found\u003c/code> instead of an empty array (even when the account has no event definitions yet). Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"GET","parameters":[{"description":"\u003cp>Get definitions with the name.\u003c/p>\n","type":"string","required":false,"default":"","example":"Product - Add to Cart Link","values":[],"key":"name"},{"description":"\u003cp>get definitions that are of a certain type (page_action, data, named).\u003c/p>\n","type":"string","required":false,"default":"","example":"page_action","values":[],"key":"type"},{"description":"\u003cp>Get a specific page\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Limit the per page results and defaults to 10 with a maximum of 50.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[{\n    \"id\": 899,\n    \"name\": \"Product - Add to Cart Link\",\n    \"type\": \"page_action\",\n    \"conditionIds\": [67275, 67228],\n    \"elementType\": \"css_selector\",\n    \"data\": \"a.add-to-cart\",\n    \"trigger\": \"click\",\n    \"fastBinding\": true,\n    \"allowIncompleteCalls\": true,\n    \"labels\": [{\n        \"key\": \"Lifecycle\",\n        \"value\": \"prod\"\n    }]\n}]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No event definitions could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/events/search","actions":[{"name":"Search event definitions","relation":"","uriTemplate":"","description":"\u003cblockquote>\n\u003cp>A search with no matching records returns \u003ccode>404 Not Found\u003c/code> instead of an empty array (even when the account has no event definitions yet). Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"POST","parameters":[{"description":"\u003cp>Get the requested fields for the resulting event definitions.\u003c/p>\n","type":"string","required":false,"default":"","example":"id, name, type, modifyDate, trigger, dataDefinitionId, ... ","values":[],"key":"fields"},{"description":"\u003cp>Sort the resulting event definitions by the given field name. Acceptable field names are 'name', 'modifyDate', 'id', 'eventType'. A '-' prefix indicates sort in descending order.\u003c/p>\n","type":"string","required":false,"default":"","example":"-name","values":[],"key":"sort"},{"description":"\u003cp>Filters event definitions based on the given parameters. Each parameter takes a JSON array. Acceptable parameters in this object are\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>"eventName" (array of event definition names, e.g. \u003ccode>["Account - Sign Up Complete"]\u003c/code>)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"eventId" (array of event ids, e.g. \u003ccode>[1, 2]\u003c/code>)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"eventTypeId" (array of event type ids, e.g. \u003ccode>[0]\u003c/code>)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"labels" (object mapping label keys to arrays of acceptable values, e.g. \u003ccode>{"Lifecycle": ["prod", "stage"]}\u003c/code>)\u003c/p>\n\u003c/li>\n\u003c/ul>\n","type":"object","required":true,"default":"","example":"","values":[],"key":"filters"},{"description":"\u003cp>Get a specific page. Is applicable only in conjunction with the 'per_page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Limit the per page results. Is applicable only in conjunction with the 'page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"{\n    \"fields\": \"id, name, type, modifyDate, conditionIds, elementType, trigger, data, fastBinding, allowIncompleteCalls, dataDefinitionId, fireWhenFirstSet, fireWhenValueUpdated, labels\",\n    \"filters\": {\n        \"eventName\": [\"Account - Sign Up Complete\", \"Product - Add to Cart Button\", \"Data Layer - Cart Total Updated\"],\n        \"labels\": {\n            \"Lifecycle\": [\"prod\", \"stage\"]\n        }\n    },\n    \"page\": 1,\n    \"per_page\": 10,\n    \"sort\": \"+name\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[{\n    \"id\": 1,\n    \"name\": \"Account - Sign Up Complete\",\n    \"type\": \"named\",\n    \"conditionIds\": [\n        111\n    ],\n    \"modifyDate\": \"2026-01-03T03:03:03.000Z\",\n    \"labels\": [{\n        \"key\": \"Lifecycle\",\n        \"value\": \"prod\"\n    }]\n},\n{\n    \"id\": 2,\n    \"name\": \"Product - Add to Cart Button\",\n    \"type\": \"page_action\",\n    \"conditionIds\": [\n        222\n    ],\n    \"modifyDate\": \"2026-01-01T01:01:01.000Z\",\n    \"elementType\": \"css_selector\",\n    \"trigger\": \"click\",\n    \"data\": \"#addToCartButton\",\n    \"fastBinding\": true,\n    \"allowIncompleteCalls\": false,\n    \"labels\": [{\n        \"key\": \"Lifecycle\",\n        \"value\": \"prod\"\n    }]\n},\n{\n    \"id\": 3,\n    \"name\": \"Data Layer - Cart Total Updated\",\n    \"type\": \"data\",\n    \"conditionIds\": [\n        333\n    ],\n    \"modifyDate\": \"2026-01-02T01:02:02.000Z\",\n    \"dataDefinitionId\": 12345,\n    \"fireWhenFirstSet\": true,\n    \"fireWhenValueUpdated\": true,\n    \"labels\": [{\n        \"key\": \"Lifecycle\",\n        \"value\": \"prod\"\n    }]\n}]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No event definitions could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the event definition id to perform action with.\u003c/p>\n","type":"number","required":true,"default":"","example":"1","values":[],"key":"id"}],"uriTemplate":"/manage/events/{id}","actions":[{"name":"Get an event definition by id","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 899,\n    \"name\": \"My Event Definition\",\n    \"type\": \"page_action\",\n    \"conditionIds\": [67275, 67228],\n    \"dataDefinitionId\": 100,\n    \"elementType\": \"css_selector\",\n    \"data\": \"a.add-to-cart\",\n    \"trigger\": \"click\",\n    \"fastBinding\": true,\n    \"allowIncompleteCalls\": true,\n    \"fireWhenFirstSet\": true,\n    \"fireWhenValueUpdated\": true,\n    \"labels\": [{\n        \"key\": \"Lifecycle\",\n        \"value\": \"prod\"\n    }]\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The event definition id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No event definitions could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Update an event definition","relation":"","uriTemplate":"","description":"\u003cp>When updating an event definition, it can be of a specific type. See the documentation above\nfrom \u003cstrong>Event Definition types and allowed fields\u003c/strong> for more information on what to provide.\u003c/p>","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"name\": \"My Updated Event Definition\",\n    \"type\": \"page_action\",\n    \"conditionIds\": [67275, 67228],\n    \"elementType\": \"css_selector\",\n    \"data\": \"a.add-to-cart\",\n    \"trigger\": \"click\",\n    \"fastBinding\": true,\n    \"allowIncompleteCalls\": true\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The event definition id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"}],"name":"","description":""}]},{"name":"Delete an event definition","relation":"","uriTemplate":"","description":"","method":"DELETE","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01..."},"headers1A":[{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The event definition id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/events","actions":[{"name":"Create an event definition","relation":"","uriTemplate":"","description":"\u003cp>When creating an event definition, it can be of a specific type. See the documentation above\nfrom \u003cstrong>Event Definition types and allowed fields\u003c/strong> for more information on what to provide.\u003c/p>","method":"POST","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"name\": \"My Event Definition\",\n    \"type\": \"page_action\",\n    \"conditionIds\": [67275, 67228],\n    \"elementType\": \"css_selector\",\n    \"data\": \"a.add-to-cart\",\n    \"trigger\": \"click\",\n    \"fastBinding\": true,\n    \"allowIncompleteCalls\": true,\n    \"labels\": [\n        {\n            \"key\": \"Lifecycle\",\n            \"value\": \"prod\"\n        }\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01..."},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 899\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"201"}],"name":"","description":""}]}],"description":""}]},{"name":"Labels","description":"\u003cp>CRUD operations with \u003cstrong>Labels\u003c/strong>.\u003c/p>\n\u003ch2>Label specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">key\u003c/td>\n\u003ctd align=\"left\">The key of the label\u003c/td>\n\u003ctd align=\"left\">A string up to 128 characters. Should only contain alphanumerics (a-z, A-Z, 0-9), periods, +, =, :, @, _, or -\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">value\u003c/td>\n\u003ctd align=\"left\">The value of the label\u003c/td>\n\u003ctd align=\"left\">A string up to 255 characters. Should only contain alphanumerics (a-z, A-Z, 0-9), periods, +, =, :, @, _, or -\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">resources\u003c/td>\n\u003ctd align=\"left\">An array of unique identifiers for the resources.\u003c/td>\n\u003ctd align=\"left\">Each resource is referenced by an \u003cstrong>Ensighten Resource Name (ERN\u003c/strong> in the format: \u003ccode>ern:ens:manage::{resource-type}:{resource-id}\u003c/code>\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003ch4>Ensighten Resource Names (ERNs)\u003c/h4>\n\u003cp>\u003cstrong>Ensighten Resource Names (ERNs)\u003c/strong> provide a standardized way to uniquely identify resources across the Ensighten platform. Every ERN follows a consistent structure that encodes the namespace, service, resource type, and unique identifier.\u003c/p>\n\u003cp>\u003cstrong>Format\u003c/strong>\u003c/p>\n\u003cpre>\u003ccode>ern:ens:manage::{resource-type}:{resource-id}\n\u003c/code>\u003c/pre>\n\u003cul>\n\u003cli>\n\u003cp>\u003ccode>{resource-type}\u003c/code> - type of resource (e.g., deployment, condition, space)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>\u003ccode>{resource-id}\u003c/code> - unique ID for the resource\u003c/p>\n\u003c/li>\n\u003c/ul>\n\u003cp>\u003cstrong>Examples\u003c/strong>\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>Condition:\u003c/p>\n\u003cp>\u003ccode>ern:ens:manage::condition:{condition-id}\u003c/code>\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Data Definition:\u003c/p>\n\u003cp>\u003ccode>ern:ens:manage::datadefinition:{datadefinition-id}\u003c/code>\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Deployment:\u003c/p>\n\u003cp>\u003ccode>ern:ens:manage::deployment:space/{space-id}/deployment/{deployment-id}\u003c/code>\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Event:\u003c/p>\n\u003cp>\u003ccode>ern:ens:manage::event:{event-id}\u003c/code>\u003c/p>\n\u003c/li>\n\u003c/ul>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/labels/search","actions":[{"name":"Search Labels","relation":"","uriTemplate":"","description":"\u003cblockquote>\n\u003cp>A search with no matching records returns \u003ccode>404 Not Found\u003c/code> instead of an empty array (even when the account has no labels yet). Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"POST","parameters":[{"description":"\u003cp>Comma-separated list of fields to include in the response. For example, use \u003ccode>labels, resource\u003c/code> to return both label and resource information.\u003c/p>\n","type":"string","required":false,"default":"","example":"labels, resource","values":[],"key":"fields"},{"description":"\u003cp>Sort the results by the specified field. Acceptable field names: \u003ccode>resource\u003c/code>. Prefix with \u003ccode>-\u003c/code> for descending order (e.g., \u003ccode>-resource\u003c/code>).\u003c/p>\n","type":"string","required":false,"default":"","example":"-resource","values":[],"key":"sort"},{"description":"\u003cp>Object to filter results. Acceptable filter keys \u003cstrong>(only one may be provided per request)\u003c/strong>:\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>labels (object) ... Filter by label keys and their allowed values. Example: \u003ccode>"labels": {"Lifecycle": ["prod", "stage"]}\u003c/code>.\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>resources (array) ... Filter by resource identifiers. Example: \u003ccode>"resources": ["ern:ens:manage::deployment:space/123/deployment/456"]\u003c/code>.\u003c/p>\n\u003c/li>\n\u003c/ul>\n","type":"object","required":false,"default":"","example":"{\"labels\": {\"Lifecycle\": []}}","values":[],"key":"filters"},{"description":"\u003cp>Page number for paginated results. Only used with \u003ccode>per_page\u003c/code>.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Number of results per page. Only used with \u003ccode>page\u003c/code>.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"{\n  \"filters\": {\n    \"resources\": [],\n    \"labels\": {\n      \"Lifecycle\": [],\n      \"Owner\": [\"marketing\"]\n    }\n  },\n  \"sort\": \"-resource\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01..."},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"[\n  {\n    \"resource\": \"ern:ens:manage::deployment:space/789/deployment/1011\",\n    \"labels\": [\n      {\n        \"key\": \"Lifecycle\",\n        \"value\": \"stage\"\n      },\n      {\n        \"key\": \"Owner\",\n        \"value\": \"marketing\"\n      }\n    ]\n  },\n  {\n    \"resource\": \"ern:ens:manage::deployment:space/123/deployment/456\",\n    \"labels\": [\n      {\n        \"key\": \"Lifecycle\",\n        \"value\": \"prod\"\n      },\n      {\n        \"key\": \"Owner\",\n        \"value\": \"marketing\"\n      }\n    ]\n  }\n]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n  \"code\": 400,\n  \"message\": \"Bad Request\",\n  \"description\": \"Input validation error\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No labels could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/labels/batch/assign","actions":[{"name":"Batch Assign Labels","relation":"","uriTemplate":"","description":"","method":"POST","parameters":[{"description":"\u003cp>Array of resource identifiers to assign labels to.\u003c/p>\n","type":"array","required":true,"default":"","example":"[\"ern:ens:manage::deployment:space/1234/deployment/5678\"]","values":[],"key":"resources"},{"description":"\u003cp>Array of label objects to assign. Each object must have a \u003ccode>key\u003c/code> and \u003ccode>value\u003c/code>.\u003c/p>\n","type":"array","required":true,"default":"","example":"","values":[],"key":"labels"}],"headers":{},"examples":[{"requests":[{"body":"{\n  \"resources\": [ \"ern:ens:manage::deployment:space/1234/deployment/5678\" ],\n  \"labels\": [\n    {\n      \"key\": \"Lifecycle\",\n      \"value\": \"prod\"\n    },\n    {\n      \"key\": \"Owner\",\n      \"value\": \"marketing\"\n    }\n  ]\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01..."},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n  \"errors\": {}\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n  \"errors\": {\n    \"ern:ens:manage::deployment:space/1234/deployment/5678\": \"not found\"\n  }\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/labels/batch/remove","actions":[{"name":"Batch Remove Labels","relation":"","uriTemplate":"","description":"","method":"POST","parameters":[{"description":"\u003cp>Array of resource identifiers to remove labels from.\u003c/p>\n","type":"array","required":true,"default":"","example":"[\"ern:ens:manage::deployment:space/1234/deployment/5678\"]","values":[],"key":"resources"},{"description":"\u003cp>Array of label keys to remove.\u003c/p>\n","type":"array","required":true,"default":"","example":"[\"Owner\", \"Lifecycle\", \"Vendor\"]","values":[],"key":"keys"}],"headers":{},"examples":[{"requests":[{"body":"{\n  \"resources\": [ \"ern:ens:manage::deployment:space/1234/deployment/5678\" ],\n  \"keys\": [\n    \"Owner\",\n    \"Lifecycle\",\n    \"Vendor\"\n  ]\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01..."},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n  \"errors\": {}\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n  \"errors\": {\n    \"ern:ens:manage::deployment:space/1234/deployment/5678\": \"not found\"\n  }\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]}],"description":""}]},{"name":"Users","description":"\u003cp>CRUD operations with \u003cstrong>Users\u003c/strong>.\u003c/p>\n\u003ch2>User specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">username\u003c/td>\n\u003ctd align=\"left\">Unique identifier for the user\u003c/td>\n\u003ctd align=\"left\">Up to 255 characters; cannot include <, >, :, ~, +, or spaces\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">firstName\u003c/td>\n\u003ctd align=\"left\">User's first name\u003c/td>\n\u003ctd align=\"left\">Up to 255 characters; only alphanumeric characters, spaces, and hyphens allowed\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">lastName\u003c/td>\n\u003ctd align=\"left\">User's last name\u003c/td>\n\u003ctd align=\"left\">Up to 255 characters; only alphanumeric characters, spaces, and hyphens allowed\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">email\u003c/td>\n\u003ctd align=\"left\">User's email address\u003c/td>\n\u003ctd align=\"left\">A valid email format is required\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">sendNotification\u003c/td>\n\u003ctd align=\"left\">Indicates whether to send a welcome email\u003c/td>\n\u003ctd align=\"left\">Boolean value, default is false if not specified\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">multiFactorAuth\u003c/td>\n\u003ctd align=\"left\">Is MFA enabled\u003c/td>\n\u003ctd align=\"left\">A string, defaults to "disable" if not specified \u003cbr> Accepted values are: \u003cbr> "enable" \u003cbr> "disable"\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">roleIds\u003c/td>\n\u003ctd align=\"left\">A list of valid role ids assigned to the user\u003c/td>\n\u003ctd align=\"left\">An array of integer IDs (e.g., [100, 101])\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">isActive\u003c/td>\n\u003ctd align=\"left\">Indicates whether the user account is active\u003c/td>\n\u003ctd align=\"left\">Boolean value, default is true if not specified\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/users/search","actions":[{"name":"Search users","relation":"","uriTemplate":"","description":"\u003cblockquote>\n\u003cp>A search with no matching records returns \u003ccode>404 Not Found\u003c/code> instead of an empty array. Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"POST","parameters":[{"description":"\u003cp>Get the requested fields for the resulting users.\u003c/p>\n","type":"string","required":false,"default":"","example":"id, account, clientId, email, firstName, lastName, lastLoginTimestamp, multiFactorAuth, name, roles, username, isActive","values":[],"key":"fields"},{"description":"\u003cp>Sort the resulting users by the given field name. Acceptable field names are 'id', 'name', 'username', 'email', 'roles', 'lastLoginTimestamp', 'isActive'. A '-' prefix indicates sort in descending order.\u003c/p>\n","type":"string","required":false,"default":"","example":"-username","values":[],"key":"sort"},{"description":"\u003cp>Filters users based on the given parameters. Acceptable parameters in this object are\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>"id" (comma-seperated list of user Ids)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"name" (comma-seperated list of user names)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"username" (comma-separated list of usernames)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"roleId" (comma-separated list of role Ids)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"email" (comma-separated list of emails)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"isActive" (boolean)\u003c/p>\n\u003c/li>\n\u003c/ul>\n","type":"object","required":false,"default":"","example":"","values":[],"key":"filters"},{"description":"\u003cp>Get a specific page. Is applicable only in conjunction with the 'per_page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Limit the per page results. Is applicable only in conjunction with the 'page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"{\n    \"fields\": \"id, account, clientId, email, firstName, lastName, lastLoginTimestamp, multiFactorAuth, name, roles, username, isActive\",\n    \"filters\": {\"username\": [\"admin\"]},\n    \"page\": 1,\n    \"per_page\": 10,\n    \"sort\": \"-name\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[{\n    \"id\": 3811,\n    \"account\": \"example-client\",\n    \"clientId\": 852,\n    \"email\": \"jane.doe@example.com\",\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"lastLoginTimestamp\": \"2024-10-10T19:54:01.000Z\",\n    \"multiFactorAuth\": \"disable\",\n    \"name\": \"Jane Doe\",\n    \"roles\": [\n        {\n            \"id\": 8515,\n            \"name\": \"Account-Admin\"\n        },\n        {\n            \"id\": 8516,\n            \"name\": \"Power User\"\n        },\n        {\n            \"id\": 8518,\n            \"name\": \"Manage UI\"\n        },\n        {\n            \"id\": 8572,\n            \"name\": \"Manage Public API\"\n        },\n        {\n            \"id\": 8575,\n            \"name\": \"Certificates\"\n        }\n    ],\n    \"username\": \"jane.doe\",\n    \"isActive\": true\n}]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No users could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/users/{id}","actions":[{"name":"Get a user","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the user.\u003c/p>\n","type":"number","required":true,"default":"","example":"3811","values":[],"key":"id"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"    {\n        \"id\": 3811,\n        \"account\": \"example-client\",\n        \"clientId\": 852,\n        \"email\": \"jane.doe@example.com\",\n        \"firstName\": \"Jane\",\n        \"lastName\": \"Doe\",\n        \"lastLoginTimestamp\": \"2024-10-10T19:54:01.000Z\",\n        \"multiFactorAuth\": \"disable\",\n        \"name\": \"Jane Doe\",\n        \"roles\": [\n            {\n                \"id\": 8515,\n                \"name\": \"Account-Admin\"\n            },\n            {\n                \"id\": 8516,\n                \"name\": \"Power User\"\n            },\n            {\n                \"id\": 8518,\n                \"name\": \"Manage UI\"\n            },\n            {\n                \"id\": 8572,\n                \"name\": \"Manage Public API\"\n            },\n            {\n                \"id\": 8575,\n                \"name\": \"Certificates\"\n            }\n        ],\n        \"username\": \"jane.doe\",\n        \"isActive\": true\n    }","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The user id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"User doesn't exist.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Update a user","relation":"","uriTemplate":"","description":"\u003cp>See the documentation above on \u003cstrong>User specific fields\u003c/strong> (exclude sendNotification) for more information on what to provide.\u003c/p>","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"email\": \"jane.doe@example.com\",\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"username\": \"jane.doe\",\n    \"roleIds\": [8515, 8516],\n    \"isActive\": true\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The user id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"User doesn't exist.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]},{"name":"Delete a user","relation":"","uriTemplate":"","description":"","method":"DELETE","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01..."},"headers1A":[{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"The user id is invalid\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"User doesn't exist.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/users","actions":[{"name":"Create a user","relation":"","uriTemplate":"","description":"","method":"POST","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"username\": \"jane.doe\",\n    \"email\": \"jane.doe@example.com\",\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"multiFactorAuth\": \"enable\",\n    \"roleIds\": [8515, 8516],\n    \"sendNotification\": true,\n    \"isActive\": true\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01..."},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"id\": 3811,\n    \"clientId\": 852,\n    \"account\": \"example-client\",\n    \"username\": \"jane.doe\",\n    \"email\": \"jane.doe@example.com\",\n    \"firstName\": \"Jane\",\n    \"lastName\": \"Doe\",\n    \"multiFactorAuth\": \"enable\",\n    \"roles\": [\n        {\n            \"id\": 8515,\n            \"name\": \"Account-Admin\"\n        },\n        {\n            \"id\": 8516,\n            \"name\": \"Power User\"\n        }\n    ],\n    \"isActive\": true\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"201"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"Username already exists for this client.\"\n}","schema":"","description":"\u003cp>Returned when a username already exists for this client.\u003c/p>","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"},{"body":"{\n    \"code\": 400,\n    \"message\": \"Bad Request\",\n    \"description\": \"Input validation error\"\n}","schema":"","description":"\u003cp>Returned when required fields are missing or invalid.\u003c/p>","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"400"}],"name":"","description":""}]}],"description":"\u003cp>When creating a user, "firstName", "lastName", "username", "email" and "roleIds" are required fields. See the documentation above\non \u003cstrong>User specific fields\u003c/strong> for more information on what to provide.\u003c/p>"}]},{"name":"Roles","description":"\u003cp>CRUD operations with \u003cstrong>Roles\u003c/strong>.\u003c/p>\n\u003ch2>Role specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">name\u003c/td>\n\u003ctd align=\"left\">Unique identifier for the role\u003c/td>\n\u003ctd align=\"left\">Up to 255 characters; Role name should only contain alphanumerics (a-z, A-Z, 0-9), periods, commas, +, =, @, _, or -"\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">creationDate\u003c/td>\n\u003ctd align=\"left\">Date the role was created\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">modifiedDate\u003c/td>\n\u003ctd align=\"left\">Date the role was updated\u003c/td>\n\u003ctd align=\"left\">\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/roles/search","actions":[{"name":"Search roles","relation":"","uriTemplate":"","description":"\u003cblockquote>\n\u003cp>A search with no matching records returns \u003ccode>404 Not Found\u003c/code> instead of an empty array. Treat this 404 as an empty result set.\u003c/p>\n\u003c/blockquote>","method":"POST","parameters":[{"description":"\u003cp>Get the requested fields for the resulting roles.\u003c/p>\n","type":"string","required":false,"default":"","example":"id, name, creationDate, modifiedDate","values":[],"key":"fields"},{"description":"\u003cp>Sort the resulting roles by the given field name. Acceptable field names are 'id', 'name', 'creationDate' and 'modifiedDate'. A '-' prefix indicates sort in descending order.\u003c/p>\n","type":"string","required":false,"default":"","example":"-name","values":[],"key":"sort"},{"description":"\u003cp>Filters roles based on the given parameters. Acceptable parameters in this object are\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>"id" (comma-seperated list of role Ids)\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>"name" (comma-seperated list of role names)\u003c/p>\n\u003c/li>\n\u003c/ul>\n","type":"object","required":false,"default":"","example":"","values":[],"key":"filters"},{"description":"\u003cp>Get a specific page. Is applicable only in conjunction with the 'per_page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"page"},{"description":"\u003cp>Limit the per page results. Is applicable only in conjunction with the 'page' parameter.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"per_page"}],"headers":{},"examples":[{"requests":[{"body":"{\n    \"fields\": \"id, name, creationDate, modifiedDate\",\n    \"filters\": {\"name\": [\"admin\"]},\n    \"page\": 1,\n    \"per_page\": 10,\n    \"sort\": \"-name\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json","X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"},{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"[{\n    \"id\": 7928,\n    \"name\": \"Account Admin\",\n    \"creationDate\": \"2023-07-24T19:16:41.000Z\",\n    \"modifiedDate\": \"2023-07-24T19:16:41.000Z\"\n}]","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"},{"body":"{\n    \"code\": 404,\n    \"message\": \"Not Found\",\n    \"description\": \"No roles could be found given the passed criteria.\"\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"404"}],"name":"","description":""}]}],"description":""}]},{"name":"SCIM 2.0","description":"\u003cp>SCIM2 (System for Cross-domain Identity Management) is a specification that automates user and group identity provisioning across cloud-based applications and services using SSO and Identity Providers. These SCIM2 API's enable user and group management through dedicated resources. SCIM follows RESTful principles, using HTTP methods with schema-defined payloads that include attributes and values.\u003c/p>\n\u003cblockquote>\n\u003cp>While using the SCIM APIs, set the value of the Accept header as \u003ccode>application/scim+json\u003c/code>.\u003c/p>\n\u003c/blockquote>\n\u003cblockquote>\n\u003cp>It is suggested to authenticate with the APIs using \u003ccode>Authorization: Bearer ens_01...\u003c/code>. However, the use of \u003ccode>X-API-KEY: ens_01...\u003c/code> is also supported.\u003c/p>\n\u003c/blockquote>\n\u003ch2>SCIM 2.0 User specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">userName\u003c/td>\n\u003ctd align=\"left\">Unique identifier for the user\u003c/td>\n\u003ctd align=\"left\">Up to 255 characters; cannot include <, >, :, ~, +, or spaces\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">name\u003c/td>\n\u003ctd align=\"left\">User's name object containing givenName and familyName\u003c/td>\n\u003ctd align=\"left\">Object with givenName and familyName fields\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">emails\u003c/td>\n\u003ctd align=\"left\">User's email addresses\u003c/td>\n\u003ctd align=\"left\">Array of email objects with value and type fields, only a single work or primary work email is supported\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">active\u003c/td>\n\u003ctd align=\"left\">Whether the user is active\u003c/td>\n\u003ctd align=\"left\">Boolean value (true or false)\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">groups\u003c/td>\n\u003ctd align=\"left\">Groups the user belongs to\u003c/td>\n\u003ctd align=\"left\">Array of group objects with value fields, value must be the group id (the same id used by /scim2/Groups/{id}); group names are not accepted and result in a 400 error. Responses also include a display sub-attribute containing the group name\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003ch2>SCIM 2.0 Group specific fields\u003c/h2>\n\u003cblockquote>\n\u003cp>Note: The Group resource is a SCIM 2.0 object that maps to the values from underlying Manage Role resources.\u003c/p>\n\u003c/blockquote>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">displayName\u003c/td>\n\u003ctd align=\"left\">The display name of the group\u003c/td>\n\u003ctd align=\"left\">Up to 255 characters; displayName should only contain alphanumerics (a-z, A-Z, 0-9), periods, commas, +, =, @, _, or -\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">members\u003c/td>\n\u003ctd align=\"left\">The users who belong to this group\u003c/td>\n\u003ctd align=\"left\">Array of user objects with value fields, value should be the users ID\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003ch2>SCIM 2.0 Field Restrictions\u003c/h2>\n\u003cp>Fields that are not mentioned in the tables above are not supported. Some fields may contain placeholder values. For example, "displayName" will always return the users givenName + familyName instead of a dedicated displayName value. This is because this field is part of a standard SCIM response that may be expected.\nAdditionally, updates on the following fields are not supported:\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>Users userName\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>Groups displayName\u003c/p>\n\u003c/li>\n\u003c/ul>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/scim2/Users","actions":[{"name":"Create a User","relation":"","uriTemplate":"","description":"","method":"POST","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"userName\": \"jane.doe\",\n    \"name\": {\n        \"givenName\": \"Jane\",\n        \"familyName\": \"Doe\"\n    },\n    \"emails\": [\n        {\n            \"value\": \"jane.doe@example.com\",\n            \"type\": \"work\"\n        }\n    ],\n    \"active\": true,\n    \"groups\": [\n        {\n            \"value\": \"8520\"\n        }\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json","Authorization":"Bearer ens_01...","Accept":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"},{"name":"Authorization","value":"Bearer ens_01..."},{"name":"Accept","value":"application/scim+json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"meta\": {\n        \"resourceType\": \"User\"\n    },\n    \"id\": \"1234\",\n    \"userName\": \"jane.doe\",\n    \"displayName\": \"Jane Doe\",\n    \"name\": {\n        \"givenName\": \"Jane\",\n        \"familyName\": \"Doe\"\n    },\n    \"emails\": [\n        {\n            \"value\": \"jane.doe@example.com\",\n            \"type\": \"work\"\n        }\n    ],\n    \"active\": true,\n    \"groups\": [\n        {\n            \"value\": \"8520\",\n            \"display\": \"group1\"\n        }\n    ],\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:User\"\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"}],"status":"201"}],"name":"","description":""}]},{"name":"Search Users","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[{"description":"\u003cp>Filter expression to search users.\u003c/p>\n","type":"string","required":false,"default":"","example":"userName eq \"jane.doe\"","values":[],"key":"filter"},{"description":"\u003cp>The 1-based index of the first query result.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"startIndex"},{"description":"\u003cp>Specifies the desired maximum number of query results per page.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"count"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"Authorization":"Bearer ens_01...","Accept":"application/scim+json"},"headers1A":[{"name":"Authorization","value":"Bearer ens_01..."},{"name":"Accept","value":"application/scim+json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"totalResults\": 1,\n    \"itemsPerPage\": 10,\n    \"startIndex\": 1,\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n    ],\n    \"Resources\": [\n        {\n            \"meta\": {\n                \"resourceType\": \"User\"\n            },\n            \"id\": \"2819c223-7f76-453a-919d-413861904646\",\n            \"userName\": \"jane.doe\",\n            \"name\": {\n                \"givenName\": \"Jane\",\n                \"familyName\": \"Doe\"\n            },\n            \"emails\": [\n                {\n                    \"value\": \"jane.doe@example.com\",\n                    \"type\": \"work\"\n                }\n            ],\n            \"active\": true,\n            \"groups\": [\n                {\n                    \"value\": \"8520\",\n                    \"display\": \"group1\"\n                }\n            ],\n            \"schemas\": [\n                \"urn:ietf:params:scim:schemas:core:2.0:User\"\n            ]\n        }\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"}],"status":"200"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Unique identifier of the user.\u003c/p>\n","type":"integer","required":true,"default":"","example":"123","values":[],"key":"id"}],"uriTemplate":"/scim2/Users/{id}","actions":[{"name":"Get a User by id","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"Authorization":"Bearer ens_01...","Accept":"application/scim+json"},"headers1A":[{"name":"Authorization","value":"Bearer ens_01..."},{"name":"Accept","value":"application/scim+json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"meta\": {\n        \"resourceType\": \"User\"\n    },\n    \"id\": \"1234\",\n    \"userName\": \"jane.doe\",\n    \"displayName\": \"Jane Doe\",\n    \"name\": {\n        \"givenName\": \"Jane\",\n        \"familyName\": \"Doe\"\n    },\n    \"emails\": [\n        {\n            \"value\": \"jane.doe@example.com\",\n            \"type\": \"work\"\n        }\n    ],\n    \"active\": true,\n    \"groups\": [\n        {\n            \"value\": \"8520\",\n            \"display\": \"group1\"\n        }\n    ],\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:User\"\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"}],"status":"200"}],"name":"","description":""}]},{"name":"Update a User (PUT)","relation":"","uriTemplate":"","description":"","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"name\": {\n        \"givenName\": \"Jane\",\n        \"familyName\": \"Doe\"\n    },\n    \"emails\": [\n        {\n            \"value\": \"jane.doe@example.com\",\n            \"type\": \"work\"\n        }\n    ],\n    \"active\": true,\n    \"groups\": [\n        {\n            \"value\": \"8520\"\n        }\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json","Authorization":"Bearer ens_01...","Accept":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"},{"name":"Authorization","value":"Bearer ens_01..."},{"name":"Accept","value":"application/scim+json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"meta\": {\n        \"resourceType\": \"User\"\n    },\n    \"id\": \"1234\",\n    \"userName\": \"jane.doe\",\n    \"displayName\": \"Jane Doe\",\n    \"name\": {\n        \"givenName\": \"Jane\",\n        \"familyName\": \"Doe\"\n    },\n    \"emails\": [\n        {\n            \"value\": \"jane.doe@example.com\",\n            \"type\": \"work\"\n        }\n    ],\n    \"active\": true,\n    \"groups\": [\n        {\n            \"value\": \"8520\",\n            \"display\": \"group1\"\n        }\n    ],\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:User\"\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"}],"status":"200"}],"name":"","description":""}]},{"name":"Delete a User","relation":"","uriTemplate":"","description":"","method":"DELETE","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"Authorization":"Bearer ens_01...","Accept":"application/scim+json"},"headers1A":[{"name":"Authorization","value":"Bearer ens_01..."},{"name":"Accept","value":"application/scim+json"}],"name":"","authSchemes":[]}],"responses":[{"body":"","schema":"","description":"","headers":{},"headers1A":[],"status":"204"}],"name":"","description":""}]},{"name":"Update a User (PATCH)","relation":"","uriTemplate":"","description":"","method":"PATCH","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n    \"Operations\": [\n        {\n            \"op\": \"replace\",\n            \"path\": \"name.familyName\",\n            \"value\": \"Smith\"\n        },\n        {\n            \"op\": \"replace\",\n            \"path\": \"emails[type eq \\\"work\\\"].value\",\n            \"value\": \"jane.smith@example.com\"\n        },\n        {\n            \"op\": \"replace\",\n            \"path\": \"active\",\n            \"value\": true\n        },\n        {\n            \"op\": \"add\",\n            \"path\": \"groups\",\n            \"value\": [\n                {\n                    \"value\": \"8521\"\n                }\n            ]\n        }\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json","Authorization":"Bearer ens_01...","Accept":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"},{"name":"Authorization","value":"Bearer ens_01..."},{"name":"Accept","value":"application/scim+json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"meta\": {\n        \"resourceType\": \"User\"\n    },\n    \"id\": \"1234\",\n    \"userName\": \"jane.doe\",\n    \"name\": {\n        \"givenName\": \"Jane\",\n        \"familyName\": \"Smith\"\n    },\n    \"emails\": [\n        {\n            \"value\": \"jane.smith@example.com\",\n            \"type\": \"work\"\n        }\n    ],\n    \"active\": true,\n    \"groups\": [\n        {\n            \"value\": \"8520\",\n            \"display\": \"group1\"\n        },\n        {\n            \"value\": \"8521\",\n            \"display\": \"group2\"\n        }\n    ],\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:User\"\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"}],"status":"200"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/scim2/Groups","actions":[{"name":"Search Groups","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[{"description":"\u003cp>Filter expression to search groups.\u003c/p>\n","type":"string","required":false,"default":"","example":"displayName eq \"group1\"","values":[],"key":"filter"},{"description":"\u003cp>The 1-based index of the first query result.\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"startIndex"},{"description":"\u003cp>Specifies the desired maximum number of query results per page.\u003c/p>\n","type":"number","required":false,"default":"","example":"10","values":[],"key":"count"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"Authorization":"Bearer ens_01...","Accept":"application/scim+json"},"headers1A":[{"name":"Authorization","value":"Bearer ens_01..."},{"name":"Accept","value":"application/scim+json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"totalResults\": 1,\n    \"itemsPerPage\": 10,\n    \"startIndex\": 1,\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n    ],\n    \"Resources\": [\n        {\n            \"meta\": {\n                \"resourceType\": \"Group\"\n            },\n            \"id\": \"8520\",\n            \"displayName\": \"group1\",\n            \"schemas\": [\n                \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n            ]\n        }\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"}],"status":"200"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Unique identifier of the group.\u003c/p>\n","type":"integer","required":true,"default":"","example":"123","values":[],"key":"id"}],"uriTemplate":"/scim2/Groups/{id}","actions":[{"name":"Get a Group by id","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"Authorization":"Bearer ens_01...","Accept":"application/scim+json"},"headers1A":[{"name":"Authorization","value":"Bearer ens_01..."},{"name":"Accept","value":"application/scim+json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"meta\": {\n        \"resourceType\": \"Group\"\n    },\n    \"id\": \"123\",\n    \"displayName\": \"Engineering\",\n    \"members\": [\n        {\n            \"value\": \"5678\",\n            \"display\": \"john.doe\"\n        }\n    ],\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"}],"status":"200"}],"name":"","description":""}]},{"name":"Replace Group Membership","relation":"","uriTemplate":"","description":"","method":"PUT","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"displayName\": \"Engineering\",\n    \"members\": [\n        {\n            \"value\": \"5678\",\n            \"display\": \"john.doe\"\n        }\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json","Authorization":"Bearer ens_01...","Accept":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"},{"name":"Authorization","value":"Bearer ens_01..."},{"name":"Accept","value":"application/scim+json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"meta\": {\n        \"resourceType\": \"Group\"\n    },\n    \"id\": \"123\",\n    \"displayName\": \"Engineering\",\n    \"members\": [\n        {\n            \"value\": \"5678\",\n            \"display\": \"john.doe\"\n        }\n    ],\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"}],"status":"200"}],"name":"","description":""}]},{"name":"Update Group Membership","relation":"","uriTemplate":"","description":"","method":"PATCH","parameters":[],"headers":{},"examples":[{"requests":[{"body":"{\n    \"schemas\": [\n        \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n    ],\n    \"Operations\": [\n        {\n            \"op\": \"add\",\n            \"path\": \"members\",\n            \"value\": [\n                {\n                    \"value\": \"6789\",\n                    \"display\": \"jane.doe\"\n                }\n            ]\n        },\n        {\n            \"op\": \"remove\",\n            \"path\": \"members[value eq \\\"1234\\\"]\"\n        }\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json","Authorization":"Bearer ens_01...","Accept":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"},{"name":"Authorization","value":"Bearer ens_01..."},{"name":"Accept","value":"application/scim+json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n    \"meta\": {\n        \"resourceType\": \"Group\"\n    },\n    \"id\": \"123\",\n    \"displayName\": \"Product Development\",\n    \"members\": [\n        {\n            \"value\": \"6789\",\n            \"display\": \"jane.doe\"\n        }\n    ],\n    \"schemas\": [\n        \"urn:ietf:params:scim:schemas:core:2.0:Group\"\n    ]\n}","schema":"","description":"","headers":{"Content-Type":"application/scim+json"},"headers1A":[{"name":"Content-Type","value":"application/scim+json"}],"status":"200"}],"name":"","description":""}]}],"description":""}]},{"name":"GIT","description":"\u003cp>Operations specific to \u003cstrong>Git enabled spaces\u003c/strong>.\u003c/p>\n\u003ch2>Git specific fields\u003c/h2>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Field\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003cth align=\"left\">Valid Values\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">commitId\u003c/td>\n\u003ctd align=\"left\">Commit ID\u003c/td>\n\u003ctd align=\"left\">A SHA-1 hash, 40 characters long\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/git/commit/status/{commitId}","actions":[{"name":"Get commit status","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"\"COMMIT COMPLETE\"","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]}],"description":""}]},{"name":"TDN","description":"\u003cp>Retrieve TDN job information\u003c/p>\n\u003ch2>JSON Schema\u003c/h2>\n\u003cp>Conforms to JSON schema draft v4 specifications\u003c/p>\n\u003cpre>\u003ccode>{\n    "$schema": "http://json-schema.org/draft-04/schema#",\n    "description": "Get job response",\n    "type": "object",\n    "properties": {\n        "id": {\n            "type": "string"\n        },\n        "version": {\n            "type": "integer"\n        },\n        "user": {\n            "type": "object",\n            "properties": {\n                "id": {\n                    "type": "integer"\n                },\n                "name": {\n                    "type": "string"\n                }\n            },\n            "required": [\n                "id",\n                "name"\n            ]\n        },\n        "space": {\n            "type": "object",\n            "properties": {\n                "id": {\n                    "type": "integer"\n                },\n                "name": {\n                    "type": "string"\n                }\n            },\n            "required": [\n                "id",\n                "name"\n            ]\n        },\n        "status": {\n            "type": "string",\n            "enum": [\n                "PENDING",\n                "INITIALIZED",\n                "RUNNING",\n                "INVALIDATING",\n                "SUCCESSFUL",\n                "FAILED",\n                "TIMEOUT"\n            ]\n        },\n        "createdDate": {\n            "type": "string",\n            "pattern": "^(?:[1-9][0-9]{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9][0-9](?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]Z$"\n        },\n        "startDate": {\n            "type": [\n                "string",\n                "null"\n            ],\n            "pattern": "^(?:[1-9][0-9]{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9][0-9](?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]Z$"\n        },\n        "endDate": {\n            "type": [\n                "string",\n                "null"\n            ],\n            "pattern": "^(?:[1-9][0-9]{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9][0-9](?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]Z$"\n        }\n    },\n    "required": [\n        "id",\n        "version",\n        "status",\n        "createdDate"\n    ]\n}\n\u003c/code>\u003c/pre>\n\u003cpre>\u003ccode>{\n  "$schema": "http://json-schema.org/draft-04/schema#",\n  "description": "List jobs response",\n  "type": "object",\n  "properties": {\n    "totalPages": {\n      "type": "integer"\n    },\n    "totalElements": {\n      "type": "integer"\n    },\n    "jobs": {\n      "type": "array",\n      "items": {\n        "type": "object",\n        "properties": {\n          "id": {\n            "type": "string"\n          },\n          "version": {\n            "type": "integer"\n          },\n          "user": {\n            "type": "object",\n            "properties": {\n              "id": {\n                "type": "integer"\n              },\n              "name": {\n                "type": "string"\n              }\n            },\n            "required": [\n              "id",\n              "name"\n            ]\n          },\n          "space": {\n            "type": "object",\n            "properties": {\n              "id": {\n                "type": "integer"\n              },\n              "name": {\n                "type": "string"\n              }\n            },\n            "required": [\n              "id",\n              "name"\n            ]\n          },\n          "status": {\n            "type": "string",\n            "enum": [\n              "PENDING",\n              "INITIALIZED",\n              "RUNNING",\n              "INVALIDATING",\n              "SUCCESSFUL",\n              "FAILED",\n              "TIMEOUT"\n            ]\n          },\n          "createdDate": {\n            "type": "string",\n            "pattern": "^(?:[1-9][0-9]{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9][0-9](?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]Z$"\n          },\n          "startDate": {\n            "type": [\n              "string",\n              "null"\n            ],\n            "pattern": "^(?:[1-9][0-9]{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9][0-9](?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]Z$"\n          },\n          "endDate": {\n            "type": [\n              "string",\n              "null"\n            ],\n            "pattern": "^(?:[1-9][0-9]{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1[0-9]|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9][0-9](?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]Z$"\n          }\n        },\n        "required": [\n          "id",\n          "version",\n          "status",\n          "createdDate"\n        ]\n      }\n    }\n  },\n  "required": [\n    "totalPages",\n    "totalElements",\n    "jobs"\n  ]\n}\n\n\u003c/code>\u003c/pre>","resources":[{"name":"","model":{},"headers":{},"parameters":[],"uriTemplate":"/manage/tdn/jobs{?completed}{?size}{?page}{?sort}","actions":[{"name":"List jobs","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[{"description":"\u003cp>Includes completed jobs, default to \u003ccode>false\u003c/code>.\u003c/p>\n","type":"boolean","required":false,"default":"","example":"true","values":[],"key":"completed"},{"description":"\u003cp>Limit the per page results, defaults to \u003ccode>100\u003c/code>\u003c/p>\n","type":"number","required":false,"default":"","example":"1","values":[],"key":"size"},{"description":"\u003cp>Results page you want to retrieve (0..N).\u003c/p>\n","type":"number","required":false,"default":"","example":"0","values":[],"key":"page"},{"description":"\u003cp>Sort the resulting jobs by the given field name. Acceptable field names are 'createdDate', 'endDate', 'id', 'startDate', 'status' and 'type'. A '-' prefix indicates sort in descending order. By default we sort by \u003ccode>id\u003c/code> in ascending order.\u003c/p>\n","type":"string","required":false,"default":"","example":"+id","values":[],"key":"sort"}],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n  \"jobs\": [\n    {\n      \"createdDate\": \"string\",\n      \"endDate\": \"string\",\n      \"id\": \"string\",\n      \"space\": {\n        \"id\": 0,\n        \"name\": \"string\"\n      },\n      \"startDate\": \"string\",\n      \"status\": \"RUNNING\",\n      \"type\": \"PUBLISH\",\n      \"user\": {\n        \"id\": 0,\n        \"name\": \"string\"\n      },\n      \"version\": 0\n    }\n  ],\n  \"totalElements\": 0,\n  \"totalPages\": 0\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]}],"description":""},{"name":"","model":{},"headers":{},"parameters":[{"description":"\u003cp>Numeric \u003ccode>id\u003c/code> of the job id to retrieve.\u003c/p>\n","type":"number","required":true,"default":"","example":"1","values":[],"key":"id"}],"uriTemplate":"/manage/tdn/jobs/{id}","actions":[{"name":"Get a job by id","relation":"","uriTemplate":"","description":"","method":"GET","parameters":[],"headers":{},"examples":[{"requests":[{"body":"","schema":"","description":"","headers":{"X-API-Key":"ens_01...","Accept":"application/json"},"headers1A":[{"name":"X-API-Key","value":"ens_01..."},{"name":"Accept","value":"application/json"}],"name":"","authSchemes":[]}],"responses":[{"body":"{\n  \"createdDate\": \"string\",\n  \"endDate\": \"string\",\n  \"id\": \"string\",\n  \"space\": {\n    \"id\": 0,\n    \"name\": \"string\"\n  },\n  \"startDate\": \"string\",\n  \"status\": \"RUNNING\",\n  \"type\": \"PUBLISH\",\n  \"user\": {\n    \"id\": 0,\n    \"name\": \"string\"\n  },\n  \"version\": 0\n}","schema":"","description":"","headers":{"Content-Type":"application/json"},"headers1A":[{"name":"Content-Type","value":"application/json"}],"status":"200"}],"name":"","description":""}]}],"description":""}]},{"name":"Additional documentation","description":"\u003cp>This section contains additional documentation on request and response values.\u003c/p>\n\u003ch3>Http Response Codes\u003c/h3>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Code\u003c/th>\n\u003cth align=\"left\">Text\u003c/th>\n\u003cth align=\"left\">Description\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">200\u003c/td>\n\u003ctd align=\"left\">OK\u003c/td>\n\u003ctd align=\"left\">Success!\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">201\u003c/td>\n\u003ctd align=\"left\">Created\u003c/td>\n\u003ctd align=\"left\">Successful creation of a resource.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">204\u003c/td>\n\u003ctd align=\"left\">No Content\u003c/td>\n\u003ctd align=\"left\">The request was processed successfully, but no response body is needed.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">400\u003c/td>\n\u003ctd align=\"left\">Bad Request\u003c/td>\n\u003ctd align=\"left\">The request was invalid or cannot be otherwise served. This usually means malformed syntax or a bad query.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">401\u003c/td>\n\u003ctd align=\"left\">Unauthorized\u003c/td>\n\u003ctd align=\"left\">Authentication credentials were missing or incorrect.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">403\u003c/td>\n\u003ctd align=\"left\">Forbidden\u003c/td>\n\u003ctd align=\"left\">The request is understood, but it has been refused or access is not allowed.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">404\u003c/td>\n\u003ctd align=\"left\">Not Found\u003c/td>\n\u003ctd align=\"left\">The URI requested is invalid or the resource requested, such as a deployment, does not exists. Search endpoints also return this code when no records match the given search criteria (including when no records of that type exist in the account yet); in that case treat the 404 as an empty result set.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">406\u003c/td>\n\u003ctd align=\"left\">Not Acceptable\u003c/td>\n\u003ctd align=\"left\">Requested representation not available for the resource, such as the \u003cstrong>Accept\u003c/strong> header is not valid.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">412\u003c/td>\n\u003ctd align=\"left\">Precondition Failed\u003c/td>\n\u003ctd align=\"left\">The request assumes that a pre-condition is met, but is not in this case.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">415\u003c/td>\n\u003ctd align=\"left\">Unsupported Media Type\u003c/td>\n\u003ctd align=\"left\">The request includes data that is not support, such as the \u003cstrong>Content-Type\u003c/strong> header is invalid.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">422\u003c/td>\n\u003ctd align=\"left\">Unprocessable Entity\u003c/td>\n\u003ctd align=\"left\">The data included with the request could not be processed. This usually would mean that invalid JSON was included.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">429\u003c/td>\n\u003ctd align=\"left\">Too Many Requests\u003c/td>\n\u003ctd align=\"left\">Returned when a request cannot be served due to rate limit having been exhausted for the resource.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">500\u003c/td>\n\u003ctd align=\"left\">Internal Server Error\u003c/td>\n\u003ctd align=\"left\">Something is broken on our end.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">502\u003c/td>\n\u003ctd align=\"left\">Bad Gateway\u003c/td>\n\u003ctd align=\"left\">The service is down or being upgraded.\u003c/td>\n\u003c/tr>\n\u003ctr>\n\u003ctd align=\"left\">503\u003c/td>\n\u003ctd align=\"left\">Service Unavailable\u003c/td>\n\u003ctd align=\"left\">The service is up, but overloaded with requests. Try again later.\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003ch3>General Error Response\u003c/h3>\n\u003cp>When an error occurs, the API returns a JSON response body with the following structure:\u003c/p>\n\u003cpre>\u003ccode class=\"json\">{\n    "code": 400,\n    "message": "Bad Request",\n    "description": "A human-readable description of what went wrong."\n}\n\u003c/code>\u003c/pre>\n\u003cp>The \u003ccode>code\u003c/code> field mirrors the HTTP status code. The \u003ccode>message\u003c/code> field is a standard HTTP status text. The \u003ccode>description\u003c/code> field provides specific detail about the error to help identify the cause.\u003c/p>\n\u003ch3>Rate Limiting\u003c/h3>\n\u003cp>To prevent abuse, it is standard practice to add some sort of rate limiting to an API. \u003ca href=\"http://tools.ietf.org/html/rfc6585\">RFC 6585\u003c/a> introduced a HTTP status code \u003ca href=\"http://tools.ietf.org/html/rfc6585#section-4\">429 Too Many Requests\u003c/a> to accommodate this.\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>\u003cstrong>HTTP Headers and Response Codes\u003c/strong>\u003c/p>\n\u003cp>New Http headers will be returned with calls that are utilizing rate limiting. Make sure you inspect these headers, as they provide important information regarding limiting.\u003c/p>\n\u003cp>For endpoints that are utilizing limiting the following headers will be returned with requests. In the event that the limit has been exceeded, the returned Http status code will be \u003cem>429 - Too many requests\u003c/em>.\u003c/p>\n\u003cul>\n\u003cli>X-Rate-Limit-Limit: the rate limit ceiling for that given request\u003c/li>\n\u003cli>X-Rate-Limit-Remaining: the number of requests left for the defined window\u003c/li>\n\u003cli>X-Rate-Limit-Reset: the remaining window, in seconds, before the rate limit resets\u003c/li>\n\u003c/ul>\n\u003cp>The response will look something like this:\u003c/p>\n\u003cpre>\u003ccode class=\"json\">    {\n        "code": 429,\n        "message": "Rate limit ceiling reached",\n        "description": "The maximum number of requests (50) for this resource has been reached. It will be reset in 350 seconds."\n    }\n\u003c/code>\u003c/pre>\n  \u003cbr>\n\u003c/li>\n\u003cli>\n\u003cp>\u003cstrong>Endpoints\u003c/strong>\u003c/p>\n\u003cp>The Manage API has applied rate limiting to certain actions. The following table outlines which calls are limited:\u003c/p>\n\u003ctable>\n\u003cthead>\n\u003ctr>\n\u003cth align=\"left\">Endpoint\u003c/th>\n\u003cth align=\"left\">Method\u003c/th>\n\u003cth align=\"left\">Scope\u003c/th>\n\u003cth align=\"left\">Limit\u003c/th>\n\u003c/tr>\n\u003c/thead>\n\u003ctbody>\n\u003ctr>\n\u003ctd align=\"left\">/manage/spaces/{id}/publish\u003c/td>\n\u003ctd align=\"left\">PUT\u003c/td>\n\u003ctd align=\"left\">Account\u003c/td>\n\u003ctd align=\"left\">5/hour\u003c/td>\n\u003c/tr>\n\u003c/tbody>\n\u003c/table>\n\u003c/li>\n\u003c/ul>\n\u003ch3>Fields Parameter\u003c/h3>\n\u003cp>The \u003cstrong>fields\u003c/strong> request parameter defines what data is returned in the response. This allows caller to pair down the data to only which is needed and thus saves vital resources as the data is transferred over the wire.\nThe fields parameter is a comma delimited list of fields to include in the response and allows for hierarchical reference to objects.\nEach resource that allows field selection will define and document how to use it. For instance, take the following JSON for a fictitious object.\u003c/p>\n\u003cpre>\u003ccode class=\"json\">{\n    "id": 100,\n    "name": "Bob Smith",\n    "address": {\n        "street": "112  Main Street",\n        "city": "Anytown",\n        "state": "California",\n        "postal": "91741"\n    }\n}\n\u003c/code>\u003c/pre>\n\u003cbr>\n\u003cp>\u003cstrong>Examples:\u003c/strong>\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>If the user wants just the id and name they would use "id, name)" for the definition which would result in the following json:\u003c/p>\n\u003cpre>\u003ccode class=\"json\">{\n    "id": 100,\n    "name": "Bob Smith",\n}\n\u003c/code>\u003c/pre>\n  \u003cbr>\n\u003c/li>\n\u003cli>\n\u003cp>If the user wants just the id, name, and post code they would use "id, name, address(postal)" for the definition which would result in the following json:\u003c/p>\n\u003cpre>\u003ccode class=\"json\">{\n    "id": 100,\n    "name": "Bob Smith",\n    "address": {\n        "postal": "91741"\n    }\n}\n\u003c/code>\u003c/pre>\n  \u003cbr>\n\u003c/li>\n\u003c/ul>\n\u003ch3>Sorting\u003c/h3>\n\u003cp>The \u003cstrong>sort\u003c/strong> request parameter defines how the data is sorted before being returned. Each resource that allows sorting will define and document which fields are supported.\nThe sort parameter is a comma delimited list of fields to sort on. If the field is preceded by a "-" character then it is assumed to be a descending sort. If the field is preceded by a "+" character or no sort character then it is presumed to be an ascending sort.\u003c/p>\n\u003cp>\u003cstrong>Examples:\u003c/strong>\u003c/p>\n\u003cul>\n\u003cli>\n\u003cp>If the user wants to have an ascending sort on the field "name", then could could define the sort option as "sort": "+name" or "sort": "name"\u003c/p>\n\u003c/li>\n\u003cli>\n\u003cp>If the user wants to have an descending sort on the field "name" and an ascending sort on "address", then could could define the sort option as "sort": "-name, +address" or "sort": "-name, address"\u003c/p>\n\u003c/li>\n\u003c/ul>","resources":[]}]}