Documentation Powered by ReDoc

IPV SDP User API (1.5.0)

Download OpenAPI specification:Download

vcds

Get list of VCDs

Get list of VCDs in a region.

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
query Parameters
status
string (Status)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds
/v1/{tenant_id}/vcds

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "vcds":
    [
    ]
}

Get specified VCD

Get a single VCD specified with an ID.

path Parameters
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}
/v1/{tenant_id}/vcds/{vcd_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "vcd":
    {
    }
}

disk_types

Get list of disk types

Get list of available disk types related to given VCD.

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
query Parameters
status
string (Status)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/disk_types
/v1/{tenant_id}/vcds/{vcd_id}/disk_types

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "disk_types":
    [
    ]
}

Get specified disk type

Get a single disk type specified with ID related to given VCD.

path Parameters
disk_type_id
required
string <uuid> (Disk Type Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/disk_types/{disk_type_id}
/v1/{tenant_id}/vcds/{vcd_id}/disk_types/{disk_type_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "disk_type":
    {
    }
}

flavors

Get list of flavors

Get list of available flavors related to given VCD.

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
query Parameters
status
string (Status)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/flavors
/v1/{tenant_id}/vcds/{vcd_id}/flavors

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "flavors":
    [
    ]
}

Get specified flavor

Get a single flavor specified with an ID related to given VCD.

path Parameters
flavor_id
required
string <uuid> (Flavor Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/flavors/{flavor_id}
/v1/{tenant_id}/vcds/{vcd_id}/flavors/{flavor_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "flavor":
    {
    }
}

organizations

Get list of organizations

Get list of available organizations on given VCD.

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations
/v1/{tenant_id}/vcds/{vcd_id}/organizations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "organizations":
    [
    ]
}

Create an organization

Create an organization on given VCD.

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some organization(s) are under processing(with status pending_*). Please wait until all process is done.

409

The name given is already used in other organization(s).

500

Some internal server error occurred.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations
/v1/{tenant_id}/vcds/{vcd_id}/organizations

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "organization":
    {
    }
}

Get specified organization

Get a single organization specified with an ID on given VCD.

path Parameters
org_id
required
string <uuid> (Org Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{org_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{org_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "organization":
    {
    }
}

Delete specified organization

Delete specified organization from given VCD.

path Parameters
org_id
required
string <uuid> (Org Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some organization(s) are under processing(with status pending_*). Please wait until all process is done.

500

Some internal server error occurred.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{org_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{org_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "detail":
    [
    ]
}

org_admins

Get list of VCD organization administrators

Get list of org_admin(Organization Administrator)s within given organization on the VCD.

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
query Parameters
status
string (Status)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_admins":
    [
    ]
}

Create an organization administrator

Create an org_admin(Organization Administrator) within given organization on the VCD.

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
org_admin
required
object (OrgAdminRequestCreate)

OrgAdmin schama for User API create request.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

409

The name given is already used in the organization.

500

Some internal server error occurred.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_admin":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_admin":
    {
    }
}

Get specified organization administrator

Get a single org_admin(Organization Administrator) specified with an ID within given organization on the VCD.

path Parameters
org_admin_id
required
string <uuid> (Org Admin Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_admin":
    {
    }
}

Update specified organization administrator

Update a single org_admin(Organization Administrator) specified with an ID within given organization on the VCD.

path Parameters
org_admin_id
required
string <uuid> (Org Admin Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
org_admin
required
object (OrgAdminRequestUpdate)

OrgAdmin schama for User API create request.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_admin":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_admin":
    {
    }
}

Delete specified organization administrator

Delete a single org_admin(Organization Administrator) from given organization on the VCD.

path Parameters
org_admin_id
required
string <uuid> (Org Admin Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/org_admins/{org_admin_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "detail":
    [
    ]
}

backup

Get Cohesity backup total logical usage

Get total logical usage of Cohesity backup in bytes.

path Parameters
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/backup
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/backup

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "backup":
    {
    }
}

vdcs

Get list of vdcs

Get list of vdc(Virtual Data Center)s within given organization on the VCD.

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "vdcs":
    [
    ]
}

Create a vdc

Create a vdc(Virtual Data Center) within given organization on the VCD.

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
vdc
required
object (VdcRequestCreate)

Vdc schama for User API create request.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some vdc(s) are under processing(with status pending_*). Please wait until all process is done.

409

The name given is already used in other vdc(s) in the organization.

500

Some internal server error occurred.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "vdc":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "vdc":
    {
    }
}

Get specified vdc

Get a single vdc(Virtual Data Center) specified with an ID within given organization on the VCD.

path Parameters
vdc_id
required
string <uuid> (Vdc Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "vdc":
    {
    }
}

Update specified vdc

Update a single vdc(Virtual Data Center) specified with an ID within given organization on the VCD.

path Parameters
vdc_id
required
string <uuid> (Vdc Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
vdc
required
object (VdcRequestUpdate)

Vdc schema for User API update request.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some vdc(s) are under processing(with status pending_*). Please wait until all process is done.

409

The name given is already used in other vdc(s) in the organization.

500

Some internal server error occurred.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "vdc":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "vdc":
    {
    }
}

Delete specified vdc

Delete a single vdc(Virtual Data Center) specified with an ID from given organization on the VCD.

path Parameters
vdc_id
required
string <uuid> (Vdc Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some vdc(s) are under processing(with status pending_*). Please wait until all process is done.

500

Some internal server error occurred.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/vdcs/{vdc_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "detail":
    [
    ]
}

nsx_t_external_networks

Get list of NSX-T External Networks

Get list of NSX-T External Networks within specified organization on given VCD.

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
query Parameters
status
string (UserResourceStatusEnum)
Enum: "pending_create" "active" "pending_update" "pending_delete" "deleted" "error_creating" "error_updating" "error_deleting" "inactive"

User resource status enum.

header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "nsx_t_external_networks":
    [
    ]
}

Create an NSX-T External Network

Create an NSX-T External Network related to given organization on the VCD.

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
nsx_t_external_network
required
object (NSXTExternalNetworkRequest)

.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some nsx_t_external_network(s) are under processing(with status pending_*). Please wait until all process is done.

409

There is already a resource with same name in the organization.

500

Some internal server error occurred.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "nsx_t_external_network":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "nsx_t_external_network":
    {
    }
}

Get specified NSX-T External Network

Get a single NSX-T External Network specified with an ID related to given organization on the VCD.

path Parameters
nsx_t_external_network_id
required
string <uuid> (Nsx T External Network Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "nsx_t_external_network":
    {
    }
}

Update specified NSX-T External Network

Update a single NSX-T External Network specified with an ID related to given organization on the VCD.

path Parameters
nsx_t_external_network_id
required
string <uuid> (Nsx T External Network Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
nsx_t_external_network
required
object (NSXTExternalNetworkRequest)

.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some nsx_t_external_network(s) are under processing(with status pending_*). Please wait until all process is done.

409

There is already a resource with same name in the organization.

500

Some internal server error occurred.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "nsx_t_external_network":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "nsx_t_external_network":
    {
    }
}

Delete specified NSX-T External Network

Delete a single NSX-T External Network specified with an ID related to given organization on the VCD.

path Parameters
nsx_t_external_network_id
required
string <uuid> (Nsx T External Network Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some nsx_t_external_network(s) are under processing(with status pending_*). Please wait until all process is done.

500

Some internal server error occurred.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/nsx_t_external_networks/{nsx_t_external_network_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "detail":
    [
    ]
}

internet_gateways

Get list of Internet gateways

Get list of Internet gateways related to given organization on the VCD.

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "internet_gateways":
    [
    ]
}

Create an Internet gateway

Create an Internet gateway related to given organization on the VCD.

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
internet_gateway
required
object (InternetGatewayRequestCreate)

Internet gateway schema for User API POST request.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some internet gateway(s) are under processing(with status pending_*). Please wait until all process is done.

409

The given name is already used in the organization.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "internet_gateway":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "internet_gateway":
    {
    }
}

Get specified Internet gateway

Get a single Internet gateway specified with an ID related to given organization on the VCD.

path Parameters
internet_gateway_id
required
string <uuid> (Internet Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "internet_gateway":
    {
    }
}

Update specified Internet gateway

Update a single Internet gateway specified with an ID related to given organization on the VCD.

path Parameters
internet_gateway_id
required
string <uuid> (Internet Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
internet_gateway
required
object (InternetGatewayRequestUpdate)

Internet gateway schema for User API PUT request.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some internet gateway(s) are under processing(with status pending_*). Please wait until all process is done.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "internet_gateway":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "internet_gateway":
    {
    }
}

Delete specified Internet gateway

Delete a single Internet gateway specified with an ID related to given organization on the VCD.

path Parameters
internet_gateway_id
required
string <uuid> (Internet Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some internet gateway(s) are under processing(with status pending_*). Please wait until all process is done.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/internet_gateways/{internet_gateway_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "detail":
    [
    ]
}

internet_qos_options

Get list of Internet QoS options

Get list of QoS options for internet gateways related to given organization on the VCD.

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/internet_qos_options
/v1/{tenant_id}/vcds/{vcd_id}/internet_qos_options

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "internet_qos_options":
    [
    ]
}

Get specified Internet QoS option

Get a single Internet gateway QoS option specified with an ID related to given organization on the VCD.

path Parameters
qos_option_id
required
string <uuid> (Qos Option Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/internet_qos_options/{qos_option_id}
/v1/{tenant_id}/vcds/{vcd_id}/internet_qos_options/{qos_option_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "internet_qos_option":
    {
    }
}

fic_gateways

Get list of FIC gateways

Get list of FIC(Flexible InterConnect) gateways related to given organization on the VCD.

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fic_gateways":
    [
    ]
}

Issue a key for FIC service

Issue a Seller Key(Public Service Key) for FIC(Flexible InterConnect) service.

path Parameters
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
fic_gateway
required
object (FicGatewayRequestCreate)

Fic gateway schema for User API POST request.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some fic_gateway(s) are under processing(with status pending_*). Please wait until all process is done.

409

The given name is already used in the organization.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

Approve FIC connection creation request

Approve FIC(Flexible InterConnect) connection creation request from the FIC portal.

path Parameters
gateway_id
required
string <uuid> (Gateway Id)
method
required
string (FicGatewayApprovalMethodEnum)
Enum: "create" "update"

Fic gateway method enum.

tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some fic_gateway(s) are under processing(with status pending_*). Please wait until all process is done.

409

The given name is already used in the organization.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{gateway_id}/request_{method}_approval
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{gateway_id}/request_{method}_approval

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

Start or Update a FIC gateway service

Start or Update a FIC(Flexible InterConnect) gateway service in IPV.

path Parameters
gateway_id
required
string <uuid> (Gateway Id)
method
required
string (FicGatewayServiceMethodEnum)
Enum: "update" "start"

Fic gateway method enum.

vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some fic_gateway(s) are under processing(with status pending_*). Please wait until all process is done.

409

The given name is already used in the organization.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{gateway_id}/{method}_service
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{gateway_id}/{method}_service

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

Get specified FIC gateway

Get a single FIC(Flexible InterConnect) gateway specified with an ID related to given organization on the VCD.

path Parameters
fic_gateway_id
required
string <uuid> (Fic Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

Update specified FIC gateway

Update a single FIC(Flexible InterConnect) gateway specified with an ID related to given organization on the VCD.

path Parameters
fic_gateway_id
required
string <uuid> (Fic Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
fic_gateway
required
object (FicGatewayRequestUpdate)

Fic gateway schema for User API PUT request.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some fic_gateway(s) are under processing(with status pending_*). Please wait until all process is done.

409

The given name is already used in the organization.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "fic_gateway":
    {
    }
}

Delete specified FIC gateway

Delete a single FIC(Flexible InterConnect) gateway specified with an ID related to given organization on the VCD.

path Parameters
fic_gateway_id
required
string <uuid> (Fic Gateway Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
vcd_id
required
string <uuid> (Vcd Id)
organization_id
required
string <uuid> (Organization Id)
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some fic_gateway(s) are under processing(with status pending_*). Please wait until all process is done.

500

Some internal server error occurred.

503

The service is temporarily unavailable. Please try again later.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/fic_gateways/{fic_gateway_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "detail":
    [
    ]
}

public_ips

Get list of public IP addresses

Get list of public(global) IP addresses related to given organization on the VCD.

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "public_ips":
    [
    ]
}

Create a public IP address

Create a public(global) IP address related to given organization on the VCD.

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
public_ip
required
object (PublicIPRequestCreate)

PublicIP create request schema for User API.

Responses

201

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some public_ip(s) are under processing(with status pending_*). Please wait until all process is done.

409

There is already a resource with same name in the organization.

500

Some internal server error occurred.

503

The system is temporary unavailable. Please try again later.

post/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "public_ip":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "public_ip":
    {
    }
}

Get specified public IP address

Get a single public(global) IP address specified with an ID related to given organization on the VCD.

path Parameters
public_ip_id
required
string <uuid> (Public Ip Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "public_ip":
    {
    }
}

Update specified public IP address

Update a single public(global) IP address specified with an ID related to given organization on the VCD.

path Parameters
public_ip_id
required
string <uuid> (Public Ip Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)
Request Body schema: application/json
public_ip
required
object (PublicIPRequestUpdate)

PublicIP update request schema for User API.

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

409

There is already a resource with same name in the organization.

500

Some internal server error occurred.

put/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "public_ip":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "public_ip":
    {
    }
}

Delete specified public IP address

Delete a single public(global) IP address specified with an ID related to given organization on the VCD.

path Parameters
public_ip_id
required
string <uuid> (Public Ip Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

204

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

406

Some public_ip(s) are under processing(with status pending_*). Please wait until all process is done.

500

Some internal server error occurred.

503

The system is temporary unavailable. Please try again later.

delete/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/public_ips/{public_ip_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "detail":
    [
    ]
}

data_protection

Get list of protection groups

Get list of Cohesity protection groups related to given organization on the VCD.

path Parameters
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

503

Cohesity is not yet prepared for the organizations. Please try again later or consult support.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/data_protection/groups
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/data_protection/groups

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "protection_groups":
    [
    ]
}

Get specified protection group

Get a single Cohesity protection group specified with an ID related to given organization on the VCD.

path Parameters
protection_group_id
required
integer (Protection Group Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

503

Cohesity is not yet prepared for the organizations. Please try again later or consult support.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/data_protection/groups/{protection_group_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/data_protection/groups/{protection_group_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "protection_group":
    {
    }
}

Get list of protection runs

Get list of Cohesity protection runs related to given organization on the VCD.

path Parameters
protection_group_id
required
integer (Protection Group Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
query Parameters
last_days
integer (Last Days) [ 1 .. 30 ]
Default: 7
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

503

Cohesity is not yet prepared for the organizations. Please try again later or consult support.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/data_protection/groups/{protection_group_id}/runs
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/data_protection/groups/{protection_group_id}/runs

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "protection_runs":
    [
    ]
}

Get specified protection run

Get a single Cohesity protection run specified with an ID related to given organization on the VCD.

path Parameters
protection_group_id
required
integer (Protection Group Id)
protection_run_id
required
integer (Protection Run Id)
organization_id
required
string <uuid> (Organization Id)
vcd_id
required
string <uuid> (Vcd Id)
tenant_id
required
string (Tenant Id) ^[0-9a-f]{32}$
header Parameters
x-auth-token
required
string (X-Auth-Token)

Responses

200

Successful Response

400

Invalid request body or header.

401

Unauthorized.

403

No sufficient user role for invoking this API.

404

Resource with given URL does not exist.

500

Some internal server error occurred.

503

Cohesity is not yet prepared for the organizations. Please try again later or consult support.

get/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/data_protection/groups/{protection_group_id}/runs/{protection_run_id}
/v1/{tenant_id}/vcds/{vcd_id}/organizations/{organization_id}/data_protection/groups/{protection_group_id}/runs/{protection_run_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "protection_run":
    {
    }
}