Tenancy API#
The Tenancy REST API provides for Organization, Project, and other tenant-specific data like Licensing. These APIs offer Create, Read, Update, Delete capabilities.
Tenancy REST API are secured via certificates and credentials.
Download the Tenancy API in OpenAPI YAML format
- DELETE /v1/orgs/{org.Org}#
- Parameters:
org.Org (string) – Name of the org.Org node
- Status Codes:
200 OK – No content
- GET /v1/orgs/{org.Org}#
- Parameters:
org.Org (string) – Name of the org.Org node
- Status Codes:
200 OK – Response returned back after getting org.Org object
- PUT /v1/orgs/{org.Org}#
- Parameters:
org.Org (string) – Name of the org.Org node
- Query Parameters:
update_if_exists (boolean) – If set to false, disables update of preexisting object. Default value is true
- Status Codes:
200 OK – Default response
- GET /v1/orgs/{org.Org}/Folders#
- Parameters:
org.Org (string) – Name of the org.Org node
- Status Codes:
200 OK – Response returned back after getting org.Org objects
- GET /v1/orgs/{org.Org}/status#
- Parameters:
org.Org (string) – Name of the org.Org node
- Status Codes:
200 OK – Response returned back after getting status subresource of org.Org object
- PUT /v1/orgs/{org.Org}/status#
- Parameters:
org.Org (string) – Name of the org.Org node
- Status Codes:
200 OK – Default response
- GET /v1/projects#
- Status Codes:
200 OK – Response returned back after getting project.Project objects
- DELETE /v1/projects/{project.Project}#
- Parameters:
project.Project (string) – Name of the project.Project node
- Status Codes:
200 OK – No content
- GET /v1/projects/{project.Project}#
- Parameters:
project.Project (string) – Name of the project.Project node
- Status Codes:
200 OK – Response returned back after getting project.Project object
- PUT /v1/projects/{project.Project}#
- Parameters:
project.Project (string) – Name of the project.Project node
- Query Parameters:
update_if_exists (boolean) – If set to false, disables update of preexisting object. Default value is true
- Status Codes:
200 OK – Default response
- GET /v1/projects/{project.Project}/Networks#
- Parameters:
project.Project (string) – Name of the project.Project node
- Status Codes:
200 OK – Response returned back after getting project.Project objects
- GET /v1/projects/{project.Project}/networks#
- Parameters:
project.Project (string) – Name of the project.Project node
- Status Codes:
200 OK – Response returned back after getting network.Network objects
- DELETE /v1/projects/{project.Project}/networks/{network.Network}#
- Parameters:
project.Project (string) – Name of the project.Project node
network.Network (string) – Name of the network.Network node
- Status Codes:
200 OK – No content
- GET /v1/projects/{project.Project}/networks/{network.Network}#
- Parameters:
project.Project (string) – Name of the project.Project node
network.Network (string) – Name of the network.Network node
- Status Codes:
200 OK – Response returned back after getting network.Network object
- PUT /v1/projects/{project.Project}/networks/{network.Network}#
- Parameters:
project.Project (string) – Name of the project.Project node
network.Network (string) – Name of the network.Network node
- Query Parameters:
update_if_exists (boolean) – If set to false, disables update of preexisting object. Default value is true
- Status Codes:
200 OK – Default response
- GET /v1/projects/{project.Project}/networks/{network.Network}/status#
- Parameters:
project.Project (string) – Name of the project.Project node
network.Network (string) – Name of the network.Network node
- Status Codes:
200 OK – Response returned back after getting status subresource of network.Network object
- PUT /v1/projects/{project.Project}/networks/{network.Network}/status#
- Parameters:
project.Project (string) – Name of the project.Project node
network.Network (string) – Name of the network.Network node
- Status Codes:
200 OK – Default response