Arcserve Cloud Direct API (1.0)

Download OpenAPI specification:Download

API Reference for Arcserve Cloud Direct Menu

Authentication

Arcserve Cloud Direct

Arcserve Cloud Direct Menu

List Licenses

List Licenses

path Parameters
tenant_id
required
string ^[0-9a-f]{32}$
Example: cab37c0a5c40450d9038463783b7d53e

Tenant ID in gl1 region

query Parameters
page
integer >= 1
Default: 1

Page number of the results to fetch

per_page
integer [ 1 .. 100 ]
Default: 30

Results per page

header Parameters
X-Auth-Token
required
string
Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1/arcserve-ucd/{tenant_id}/licenses
https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/licenses

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "page": 1,
  • "per_page": 30,
  • "total_count": 2,
  • "licenses":
    [
    ]
}

Create License

Create License

path Parameters
tenant_id
required
string ^[0-9a-f]{32}$
Example: cab37c0a5c40450d9038463783b7d53e

Tenant ID in gl1 region

header Parameters
X-Auth-Token
required
string
Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Request Body schema: application/json
license
required
object

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

post/v1/arcserve-ucd/{tenant_id}/licenses
https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/licenses

Request samples

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

Response samples

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

Update License

Update License

path Parameters
license_id
required
string <uuid>

License ID

tenant_id
required
string ^[0-9a-f]{32}$
Example: cab37c0a5c40450d9038463783b7d53e

Tenant ID in gl1 region

header Parameters
X-Auth-Token
required
string
Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Request Body schema: application/json
license
required
object

Responses

200

OK if only name and email_address are updated

202

Accepted if properties other than name and email_address are updated

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

patch/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}
https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}

Request samples

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

Response samples

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

Delete License

Delete License

path Parameters
license_id
required
string <uuid>

License ID

tenant_id
required
string ^[0-9a-f]{32}$
Example: cab37c0a5c40450d9038463783b7d53e

Tenant ID in gl1 region

header Parameters
X-Auth-Token
required
string
Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

202

Accepted

204

No Content (Only if license status is Send Back)

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

delete/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}
https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}

Response samples

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

Show License

Show License

path Parameters
license_id
required
string <uuid>

License ID

tenant_id
required
string ^[0-9a-f]{32}$
Example: cab37c0a5c40450d9038463783b7d53e

Tenant ID in gl1 region

header Parameters
X-Auth-Token
required
string
Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}
https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/licenses/{license_id}

Response samples

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

Show Shortest Delivery Date

Show Shortest Delivery Date

path Parameters
tenant_id
required
string ^[0-9a-f]{32}$
Example: cab37c0a5c40450d9038463783b7d53e

Tenant ID in gl1 region

header Parameters
X-Auth-Token
required
string
Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

OK

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1/arcserve-ucd/{tenant_id}/shortest-delivery-date
https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/shortest-delivery-date

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "shortest_delivery_date": "2019-08-24"
}

List Plans

List Plans

path Parameters
tenant_id
required
string ^[0-9a-f]{32}$
Example: cab37c0a5c40450d9038463783b7d53e

Tenant ID in gl1 region

query Parameters
page
integer >= 1
Default: 1

Page number of the results to fetch

per_page
integer [ 1 .. 100 ]
Default: 30

Results per page

header Parameters
X-Auth-Token
required
string
Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

get/v1/arcserve-ucd/{tenant_id}/plans
https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/plans

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "page": 1,
  • "per_page": 30,
  • "total_count": 2,
  • "plans":
    [
    ]
}

Show Plan

Show Plan

path Parameters
tenant_id
required
string ^[0-9a-f]{32}$
Example: cab37c0a5c40450d9038463783b7d53e

Tenant ID in gl1 region

plan_id
required
string <uuid>

Plan ID

header Parameters
X-Auth-Token
required
string
Example: e1b37cb197d84e69af37264fc0f167a33

Authentication token generated by Keystone

Responses

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/arcserve-ucd/{tenant_id}/plans/{plan_id}
https://api.ntt.com/sdpf-soy/v1/arcserve-ucd/{tenant_id}/plans/{plan_id}

Response samples

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