Create Site - Cloud Security Gov

{"type":"api","title":"Create Site","meta":{"id":"/apps/pubhub/media/cloud-security-gov/cdd8786b84e1e4d80528d0eeb25987c136a18549/c79087e9-62b7-36ed-b8c1-ee9663ce1992","info":{"title":"Cisco Umbrella for Government Sites API","version":"2.0.0","description":"Manage the sites in your organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Sites"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/deployments/sites-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrellagov.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrellagov.com/auth/v2/token","scopes":{"deployments.sites:write":"Write deployments sites","deployments.sites:read":"Read deployments sites"}}}}}},"spec":{"summary":"Create Site","operationId":"createSite","tags":["Sites","Umbrella"],"description":"Create a site.","security":[{"oauthFlow":["deployments.sites:write"]}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"type":"string","description":"The name of the site. The name is a sequence of characters with a length from 1 through 255.","minLength":1,"maxLength":255}},"type":"object","required":["name"]},"example":{"name":"A site name"}}},"description":"Register a site."},"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":{"originId":{"type":"integer","description":"The origin ID of the site.","example":13456},"name":{"type":"string","description":"The name of the site.","example":"local network one"},"siteId":{"type":"integer","description":"The ID of the site.","example":1356},"isDefault":{"type":"boolean","description":"Specifies whether the site is the default.","example":true},"type":{"type":"string","description":"The type of the site."},"internalNetworkCount":{"type":"integer","description":"The number of internal networks that are attached to the site.","example":20},"vaCount":{"type":"integer","description":"The number of virtual appliances that are attached to the site.","example":25},"createdAt":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the site was created.\n","example":"2018-06-13T16:07:07.222Z"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time (ISO 8601 timestamp) when the site was modified.","example":"2018-06-13T16:07:07.222Z"}},"required":["originId","name","siteId","isDefault","modifiedAt","createdAt"],"example":{"originId":1234,"name":"Name of the site","siteId":14,"isDefault":false,"modifiedAt":"2020-03-09T22:18:26.625Z","createdAt":"2020-03-09T22:18:26.625Z"},"$$ref":"#/components/schemas/SiteObject"},"example":{"originId":1234,"name":"Name of the site","siteId":14,"isDefault":false,"type":"Type of site","internalNetworkCount":10,"vaCount":2,"modifiedAt":"2020-03-09T22:18:26.625Z","createdAt":"2020-03-09T22:18:26.625Z"}}}},"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 error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"createSite","method":"post","path":"/sites"}}