Create Internal Domain - Cloud Security API

{"type":"api","title":"Create Internal Domain","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/4de4d0df-36d7-34a8-836a-ada53135f9f7","info":{"title":"Cisco Umbrella Internal Domains API","version":"2.0.0","description":"Manage the internal domains in your organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Internal Domains"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/internal-domains-overview.md","uri":"umbrella-api-reference-internal-domains-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"deployments.internaldomains:write":"Write deployments internal domains","deployments.internaldomains:read":"Read deployments internal domains"}}}}}},"spec":{"tags":["Internal Domains","Umbrella"],"description":"Create an internal domain. If you do not assign a list of sites to the internal domain, the internal domain\nis associated with all sites in the organization.","summary":"Create Internal Domain","operationId":"createInternalDomain","security":[{"oauthFlow":["deployments.internaldomains:write"]}],"requestBody":{"description":"Create the internal domain.","required":true,"content":{"application/json":{"schema":{"properties":{"domain":{"type":"string","description":"The internal domain.","example":"cisco-internal.com"},"description":{"type":"string","description":"The description of the internal domain. The description is a sequence of characters with a length from 1 through 50.","minLength":1,"maxLength":50,"example":"A description of a domain."},"includeAllVAs":{"type":"boolean","description":"Specifies whether to apply the internal domain to all virtual appliances.","example":false},"includeAllMobileDevices":{"type":"boolean","description":"Specifies whether to apply the internal domain to all mobile devices.","example":false},"siteIds":{"type":"array","items":{"type":"integer","description":"A site ID.","example":923250},"description":"The list of site IDs associated with the domain.","example":[928250,6244410]}},"type":"object","required":["domain"]},"example":{"domain":"The internal domain","description":"Description of the internal domain","includeAllVAs":false,"includeAllMobileDevices":false,"siteIds":[928250,6244410]}}},"$$ref":"#/components/requestBodies/internalDomain"},"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the internal domain.","example":1234556},"domain":{"type":"string","description":"The domain name of the internal domain.","example":"cisco-internal.com"},"description":{"type":"string","description":"The description of the internal domain.","minLength":1,"maxLength":50,"example":"An internal domain."},"includeAllVAs":{"type":"boolean","description":"Specifies whether to apply the internal domain to all virtual appliances.","example":false},"includeAllMobileDevices":{"type":"boolean","description":"Specifies whether to apply the internal domain to all mobile devices.","example":false},"createdAt":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the internal domain was created.","example":"2018-06-13T16:07:07.222Z"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the internal domain was modified.","example":"2018-06-13T16:07:07.222Z"},"siteIds":{"type":"array","items":{"type":"integer","description":"A site ID.","example":923250},"description":"The list of site IDs associated with the domain.","example":[928250,6244410]}},"required":["id","domain","description","includeAllVAs","includeAllMobileDevices","createdAt","modifiedAt","siteIds"],"example":{"id":1234,"domain":"Internal domain name","description":"internal domain description","includeAllVAs":false,"includeAllMobileDevices":false,"createdAt":"2020-03-09T22:18:26.625Z","modifiedAt":"2020-03-09T22:18:26.625Z","siteIds":[]},"$$ref":"#/components/schemas/InternalDomainObject"},"example":{"id":1234,"domain":"Internal domain name","description":"internal domain description","includeAllVAs":false,"includeAllMobileDevices":false,"createdAt":"2020-03-09T22:18:26.625Z","modifiedAt":"2020-03-09T22:18:26.625Z","siteIds":[928250,6244410]}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Validation Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Validation error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":404,"description":"HTTP status code"},"error":{"type":"string","example":"Not Found","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":500,"description":"HTTP status code"},"error":{"type":"string","example":"Internal Server Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"createInternalDomain","method":"post","path":"/internaldomains"}}