Arcserve UDP API (2.0.0)
Download OpenAPI specification:Download
| Date | Version | Detail |
|---|---|---|
| 2026/05/26 | 2.1.0 | Add bulk upgrade license Version |
| 2025/04/21 | 2.0.0 | Split endpoints by regions |
| 2024/09/10 | 1.0.0 | Initial Release |
List Licenses
List Licenses
path Parameters
| tenant_id required | string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID |
query Parameters
| page | integer >= 1 Default: 1 Page number of the results to fetch |
| per_page | integer [ 1 .. 100 ] Default: 30 Results per page |
| order_id | string <uuid> Order ID |
header Parameters
| X-Auth-Token required | string Example: e1b37cb197d84e69af37264fc0f167a33 Authentication token generated by Keystone. Details are provided on the next page. (https://sdpf.ntt.com/about-sss/api-references/first-step/) |
Responses
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
get/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp1-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp2-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp3-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp4-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp5-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp6-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp7-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp8-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp9-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "page": 1,
- "per_page": 30,
- "total_count": 2,
- "licenses": [
- {
- "id": "10888274-393c-4c62-8bdc-b818f94f0d86",
- "name": "Sample License",
- "status": "Active",
- "type": "Hypervisor",
- "order_id": "ce8421bb-3d1f-4776-992c-788880083142",
- "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "plan_name_ja": "Arcserve Unified Data Protection (UDP) 9.0 Premium Plus Edition",
- "plan_name_en": "Arcserve Unified Data Protection (UDP) 9.0 Premium Plus Edition",
- "number_of_standalone_keys": 2,
- "offer_start_date": "2022-07-14",
- "deletion_date": null,
- "plan_change_date": "2022-09-01",
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-09-01T14:15:22Z",
- "keys": [
- {
- "id": "3d39d83d-0fe5-4815-ba21-e09abae26a29",
- "key_type_id": "2d577d56-7fee-4519-b834-3ab16921ff45",
- "name": "UDP Standalone Key",
- "version": "9.0",
- "value": "Sample Value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "e8b9853b-fb86-4392-aca4-73857c2b8d1e",
- "key_type_id": "14dba235-0572-420e-aaf4-71a923dad80e",
- "name": "UDP Standalone Key",
- "version": "9.0",
- "value": "Sample Value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "25fecb0a-8aba-4797-ac73-0f11970301f1",
- "key_type_id": "d088a07f-4e68-4f39-8ed0-8e588b3e56ea",
- "name": "Backup Socket Key",
- "version": "18.0",
- "value": "Sample Value",
- "is_additional_component": true,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "6fa8f7c6-4084-4b0b-900e-9d408c618ae8",
- "key_type_id": "8976060c-251b-4874-bf9c-7c65a3ccfdc2",
- "name": "RHA Socket Key",
- "version": "16.5",
- "value": "Sample Value",
- "is_additional_component": true,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}
]
}, - {
- "id": "6e5ecdf9-730a-8fca-01b1-362eca3f40a4",
- "name": "Sample License",
- "status": "Deleted",
- "type": "Virtual Server",
- "order_id": "499c5338-2ba9-4103-a57b-f0865ecc4015",
- "plan_id": "13c2cbc9-02f5-4bd7-b065-34a06e9666f1",
- "plan_name_ja": "Arcserve Unified Data Protection (UDP) ~8.0 Advanced Edition",
- "plan_name_en": "Arcserve Unified Data Protection (UDP) ~8.0 Advanced Edition",
- "number_of_standalone_keys": null,
- "offer_start_date": "2022-07-14",
- "deletion_date": "2022-08-23",
- "plan_change_date": null,
- "created_at": "2022-07-14T14:15:22Z",
- "updated_at": "2022-08-23T14:15:22Z",
- "keys": [
- {
- "id": "1ccf5faf-df3d-489d-940c-24f270957c08",
- "key_type_id": "6c866070-63b4-4cba-9973-78ace4b6a545",
- "name": "UDP Server Key",
- "version": "8.0",
- "value": "Sample value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": "2022-08-23T14:15:22Z"
}, - {
- "id": "a4f09bd9-0325-42d9-88ab-68bd7259b6f2",
- "key_type_id": "04637cf7-9298-458c-9afb-201f294cec72",
- "name": "UDP Standalone Key",
- "version": "8.0",
- "value": "Sample Value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": "2022-08-23T14:15:22Z"
}
]
}
]
}Create License
Create License
path Parameters
| tenant_id required | string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID |
header Parameters
| X-Auth-Token required | string Example: e1b37cb197d84e69af37264fc0f167a33 Authentication token generated by Keystone. Details are provided on the next page. (https://sdpf.ntt.com/about-sss/api-references/first-step/) |
Request Body schema: application/json
| license required | object |
Responses
201
Created
202
Accepted
400
Bad Request
401
Unauthorized
403
Forbidden
500
Internal Server Error
post/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp1-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp2-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp3-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp4-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp5-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp6-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp7-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp8-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
https://soy-jp9-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "license": {
- "name": "Sample License",
- "type": "Hypervisor",
- "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "number_of_standalone_keys": 2,
- "email_address": "user1@example.com",
- "company_name": "Sample Company Name"
}
}Response samples
- 201
- 202
- 400
- 401
- 403
- 500
Content type
application/json
Copy
Expand all Collapse all {- "license": {
- "id": "2b16cd51-f110-433d-a956-300ba66ffd40",
- "name": "Sample License",
- "status": "Active",
- "type": "Hypervisor",
- "order_id": "ce8421bb-3d1f-4776-992c-788880083142",
- "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "plan_name_ja": "Arcserve Unified Data Protection (UDP) 9.0 Premium Plus Edition",
- "plan_name_en": "Arcserve Unified Data Protection (UDP) 9.0 Premium Plus Edition",
- "number_of_standalone_keys": 2,
- "offer_start_date": "2022-07-01",
- "deletion_date": null,
- "plan_change_date": null,
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-07-01T14:15:22Z",
- "keys": [
- {
- "id": "3d39d83d-0fe5-4815-ba21-e09abae26a29",
- "key_type_id": "712ac3bb-ab4c-4a8f-9746-a2ef7bc99d54",
- "name": "UDP Standalone Key",
- "version": "9.0",
- "value": "Sample Value 1",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "e8b9853b-fb86-4392-aca4-73857c2b8d1e",
- "key_type_id": "8658cdbb-7bb6-4cd3-8ce8-36187cfcd3b5",
- "name": "UDP Standalone Key",
- "version": "9.0",
- "value": "Sample Value 2",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "25fecb0a-8aba-4797-ac73-0f11970301f1",
- "key_type_id": "5cd4e508-c8fa-434e-b88b-af060c8960e5",
- "name": "Backup Socket Key",
- "version": "18.0",
- "value": "Sample value",
- "is_additional_component": true,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "6fa8f7c6-4084-4b0b-900e-9d408c618ae8",
- "key_type_id": "7a56620d-aff3-413f-982e-7289481dc9c3",
- "name": "RHA Socket Key",
- "version": "16.5",
- "value": "Sample Value",
- "is_additional_component": true,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}
]
}
}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 |
header Parameters
| X-Auth-Token required | string Example: e1b37cb197d84e69af37264fc0f167a33 Authentication token generated by Keystone. Details are provided on the next page. (https://sdpf.ntt.com/about-sss/api-references/first-step/) |
Request Body schema: application/json
| license required | object |
Responses
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
patch/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp1-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp2-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp3-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp4-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp5-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp6-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp7-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp8-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp9-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
Request samples
- Payload
Content type
application/json
Example
Example 1
Copy
Expand all Collapse all {- "license": {
- "name": "Sample License"
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "license": {
- "id": "2b16cd51-f110-433d-a956-300ba66ffd40",
- "name": "Sample License",
- "status": "Active",
- "type": "Hypervisor",
- "order_id": "ce8421bb-3d1f-4776-992c-788880083142",
- "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "plan_name_ja": "Arcserve Unified Data Protection (UDP) 9.0 Premium Plus Edition",
- "plan_name_en": "Arcserve Unified Data Protection (UDP) 9.0 Premium Plus Edition",
- "number_of_standalone_keys": 2,
- "offer_start_date": "2022-07-01",
- "deletion_date": null,
- "plan_change_date": null,
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-07-01T14:15:22Z",
- "keys": [
- {
- "id": "3d39d83d-0fe5-4815-ba21-e09abae26a29",
- "key_type_id": "712ac3bb-ab4c-4a8f-9746-a2ef7bc99d54",
- "name": "UDP Standalone Key",
- "version": "9.0",
- "value": "Sample Value 1",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "e8b9853b-fb86-4392-aca4-73857c2b8d1e",
- "key_type_id": "8658cdbb-7bb6-4cd3-8ce8-36187cfcd3b5",
- "name": "UDP Standalone Key",
- "version": "9.0",
- "value": "Sample Value 2",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "25fecb0a-8aba-4797-ac73-0f11970301f1",
- "key_type_id": "5cd4e508-c8fa-434e-b88b-af060c8960e5",
- "name": "Backup Socket Key",
- "version": "18.0",
- "value": "Sample value",
- "is_additional_component": true,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "6fa8f7c6-4084-4b0b-900e-9d408c618ae8",
- "key_type_id": "7a56620d-aff3-413f-982e-7289481dc9c3",
- "name": "RHA Socket Key",
- "version": "16.5",
- "value": "Sample Value",
- "is_additional_component": true,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}
]
}
}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 |
header Parameters
| X-Auth-Token required | string Example: e1b37cb197d84e69af37264fc0f167a33 Authentication token generated by Keystone. Details are provided on the next page. (https://sdpf.ntt.com/about-sss/api-references/first-step/) |
Responses
202
Accepted
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
delete/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp1-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp2-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp3-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp4-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp5-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp6-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp7-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp8-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp9-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
Response samples
- 202
- 400
- 401
- 403
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "license": {
- "id": "6e5ecdf9-730a-8fca-01b1-362eca3f40a4",
- "name": "Sample License",
- "status": "Deleted",
- "type": "Virtual Server",
- "order_id": "499c5338-2ba9-4103-a57b-f0865ecc4015",
- "plan_id": "13c2cbc9-02f5-4bd7-b065-34a06e9666f1",
- "plan_name_ja": "Arcserve Unified Data Protection (UDP) ~8.0 Advanced Edition",
- "plan_name_en": "Arcserve Unified Data Protection (UDP) ~8.0 Advanced Edition",
- "number_of_standalone_keys": null,
- "offer_start_date": "2022-07-14",
- "deletion_date": "2022-08-23",
- "plan_change_date": null,
- "created_at": "2022-07-14T14:15:22Z",
- "updated_at": "2022-08-23T14:15:22Z",
- "keys": [
- {
- "id": "1ccf5faf-df3d-489d-940c-24f270957c08",
- "key_type_id": "acfe42cf-25ae-470d-9493-641bcc164f0c",
- "name": "UDP Server Key",
- "version": "8.0",
- "value": "Sample value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": "2022-08-23T14:15:22Z"
}, - {
- "id": "a4f09bd9-0325-42d9-88ab-68bd7259b6f2",
- "key_type_id": "6a5c2ce4-9af3-4d44-9cf7-6c044f710604",
- "name": "UDP Standalone Key",
- "version": "8.0",
- "value": "Sample Value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": "2022-08-23T14:15:22Z"
}
]
}
}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 |
header Parameters
| X-Auth-Token required | string Example: e1b37cb197d84e69af37264fc0f167a33 Authentication token generated by Keystone. Details are provided on the next page. (https://sdpf.ntt.com/about-sss/api-references/first-step/) |
Responses
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
get/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp1-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp2-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp3-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp4-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp5-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp6-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp7-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp8-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
https://soy-jp9-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "license": {
- "id": "6e5ecdf9-730a-8fca-01b1-362eca3f40a4",
- "name": "Sample License",
- "status": "Deleted",
- "type": "Virtual Server",
- "order_id": "499c5338-2ba9-4103-a57b-f0865ecc4015",
- "plan_id": "13c2cbc9-02f5-4bd7-b065-34a06e9666f1",
- "plan_name_ja": "Arcserve Unified Data Protection (UDP) ~8.0 Advanced Edition",
- "plan_name_en": "Arcserve Unified Data Protection (UDP) ~8.0 Advanced Edition",
- "number_of_standalone_keys": null,
- "offer_start_date": "2022-07-14",
- "deletion_date": "2022-08-23",
- "plan_change_date": null,
- "created_at": "2022-07-14T14:15:22Z",
- "updated_at": "2022-08-23T14:15:22Z",
- "keys": [
- {
- "id": "1ccf5faf-df3d-489d-940c-24f270957c08",
- "key_type_id": "acfe42cf-25ae-470d-9493-641bcc164f0c",
- "name": "UDP Server Key",
- "version": "8.0",
- "value": "Sample value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": "2022-08-23T14:15:22Z"
}, - {
- "id": "a4f09bd9-0325-42d9-88ab-68bd7259b6f2",
- "key_type_id": "6a5c2ce4-9af3-4d44-9cf7-6c044f710604",
- "name": "UDP Standalone Key",
- "version": "8.0",
- "value": "Sample Value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": "2022-08-23T14:15:22Z"
}
]
}
}Issue License Key
Issue License Key
path Parameters
| tenant_id required | string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID |
| license_id required | string <uuid> License ID |
header Parameters
| X-Auth-Token required | string Example: e1b37cb197d84e69af37264fc0f167a33 Authentication token generated by Keystone. Details are provided on the next page. (https://sdpf.ntt.com/about-sss/api-references/first-step/) |
Request Body schema: application/json
| license | object |
Responses
201
Created
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
post/v2/arcserve-udp/{tenant_id}/licenses/{license_id}/issue-key
https://soy-jp1-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}/issue-key
https://soy-jp2-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}/issue-key
https://soy-jp3-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}/issue-key
https://soy-jp4-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}/issue-key
https://soy-jp5-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}/issue-key
https://soy-jp6-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}/issue-key
https://soy-jp7-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}/issue-key
https://soy-jp8-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}/issue-key
https://soy-jp9-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/licenses/{license_id}/issue-key
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "license": {
- "key_type_id": "6fa8f7c6-4084-4b0b-900e-9d408c618ae8"
}
}Response samples
- 201
- 400
- 401
- 403
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "license": {
- "id": "2b16cd51-f110-433d-a956-300ba66ffd40",
- "name": "Sample License",
- "status": "Active",
- "type": "Hypervisor",
- "order_id": "ce8421bb-3d1f-4776-992c-788880083142",
- "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "plan_name_ja": "Arcserve Unified Data Protection (UDP) 9.0 Premium Plus Edition",
- "plan_name_en": "Arcserve Unified Data Protection (UDP) 9.0 Premium Plus Edition",
- "number_of_standalone_keys": 2,
- "offer_start_date": "2022-07-01",
- "deletion_date": null,
- "plan_change_date": null,
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-07-01T14:15:22Z",
- "keys": [
- {
- "id": "3d39d83d-0fe5-4815-ba21-e09abae26a29",
- "key_type_id": "712ac3bb-ab4c-4a8f-9746-a2ef7bc99d54",
- "name": "UDP Standalone Key",
- "version": "9.0",
- "value": "Sample Value 1",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "e8b9853b-fb86-4392-aca4-73857c2b8d1e",
- "key_type_id": "8658cdbb-7bb6-4cd3-8ce8-36187cfcd3b5",
- "name": "UDP Standalone Key",
- "version": "9.0",
- "value": "Sample Value 2",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "25fecb0a-8aba-4797-ac73-0f11970301f1",
- "key_type_id": "5cd4e508-c8fa-434e-b88b-af060c8960e5",
- "name": "Backup Socket Key",
- "version": "18.0",
- "value": "Sample value",
- "is_additional_component": true,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "6fa8f7c6-4084-4b0b-900e-9d408c618ae8",
- "key_type_id": "7a56620d-aff3-413f-982e-7289481dc9c3",
- "name": "RHA Socket Key",
- "version": "16.5",
- "value": "Sample Value",
- "is_additional_component": true,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}
]
}
}Bulk Upgrade License Version
Bulk Upgrade License Version
path Parameters
| tenant_id required | string |
header Parameters
| X-Auth-Token required | string Example: e1b37cb197d84e69af37264fc0f167a33 Authentication token generated by Keystone. Details are provided on the next page. (https://sdpf.ntt.com/about-sss/api-references/first-step/) |
Request Body schema: application/json
| license_ids required | Array of strings <uuid> non-empty Each license can only be upgraded starting from the day after you create license or upgrade license. |
| version required | string This field is specified a sequence of numbers with one decimal place in string format. (The range of numbers is 0.0 < version <= 99.9) |
| email_address | string <email> <= 254 characters This parameter is required if upgrade version order does not exists in the same tenant. |
| company_name | string [ 1 .. 100 ] characters This parameter is required if upgrade version order does not exists in the same tenant. |
Responses
201
Created
202
Accepted
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
post/v2/arcserve-udp/{tenant_id}/bulk-license-upgrade
https://soy-jp1-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/bulk-license-upgrade
https://soy-jp2-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/bulk-license-upgrade
https://soy-jp3-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/bulk-license-upgrade
https://soy-jp4-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/bulk-license-upgrade
https://soy-jp5-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/bulk-license-upgrade
https://soy-jp6-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/bulk-license-upgrade
https://soy-jp7-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/bulk-license-upgrade
https://soy-jp8-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/bulk-license-upgrade
https://soy-jp9-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/bulk-license-upgrade
Request samples
- Payload
Content type
application/json
Example
Example 1
Copy
Expand all Collapse all {- "license_ids": [
- "10888274-393c-4c62-8bdc-b818f94f0d86",
- "6e5ecdf9-730a-8fca-01b1-362eca3f40a4"
], - "version": "9.0"
}Response samples
- 201
- 202
- 400
- 401
- 403
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "licenses": [
- {
- "id": "10888274-393c-4c62-8bdc-b818f94f0d86",
- "name": "Sample License",
- "status": "Active",
- "type": "Hypervisor",
- "order_id": "ce8421bb-3d1f-4776-992c-788880083142",
- "plan_id": "00713021-9aea-41da-9a88-87760c08fa72",
- "plan_name_ja": "Arcserve Unified Data Protection (UDP) 10.0 Premium Plus Edition",
- "plan_name_en": "Arcserve Unified Data Protection (UDP) 10.0 Premium Plus Edition",
- "number_of_standalone_keys": 2,
- "offer_start_date": "2022-07-14",
- "deletion_date": null,
- "plan_change_date": "2022-09-01",
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-09-01T14:15:22Z",
- "keys": [
- {
- "id": "3d39d83d-0fe5-4815-ba21-e09abae26a29",
- "key_type_id": "2d577d56-7fee-4519-b834-3ab16921ff45",
- "name": "UDP Standalone Key",
- "version": "10.0",
- "value": "Sample Value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "e8b9853b-fb86-4392-aca4-73857c2b8d1e",
- "key_type_id": "14dba235-0572-420e-aaf4-71a923dad80e",
- "name": "UDP Standalone Key",
- "version": "10.0",
- "value": "Sample Value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "25fecb0a-8aba-4797-ac73-0f11970301f1",
- "key_type_id": "d088a07f-4e68-4f39-8ed0-8e588b3e56ea",
- "name": "Backup Socket Key",
- "version": "10.0",
- "value": "Sample Value",
- "is_additional_component": true,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}, - {
- "id": "6fa8f7c6-4084-4b0b-900e-9d408c618ae8",
- "key_type_id": "8976060c-251b-4874-bf9c-7c65a3ccfdc2",
- "name": "RHA Socket Key",
- "version": "16.5",
- "value": "Sample Value",
- "is_additional_component": true,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": null
}
]
}, - {
- "id": "6e5ecdf9-730a-8fca-01b1-362eca3f40a4",
- "name": "Sample License",
- "status": "Active",
- "type": "Virtual Server",
- "order_id": "499c5338-2ba9-4103-a57b-f0865ecc4015",
- "plan_id": "13c2cbc9-02f5-4bd7-b065-34a06e9666f1",
- "plan_name_ja": "Arcserve Unified Data Protection (UDP) 10.0 Advanced Edition",
- "plan_name_en": "Arcserve Unified Data Protection (UDP) 10.0 Advanced Edition",
- "number_of_standalone_keys": null,
- "offer_start_date": "2022-07-14",
- "deletion_date": null,
- "plan_change_date": "2022-09-01",
- "created_at": "2022-07-14T14:15:22Z",
- "updated_at": "2022-09-01T14:15:22Z",
- "keys": [
- {
- "id": "1ccf5faf-df3d-489d-940c-24f270957c08",
- "key_type_id": "6c866070-63b4-4cba-9973-78ace4b6a545",
- "name": "UDP Server Key",
- "version": "10.0",
- "value": "Sample value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": "2022-08-23T14:15:22Z"
}, - {
- "id": "a4f09bd9-0325-42d9-88ab-68bd7259b6f2",
- "key_type_id": "04637cf7-9298-458c-9afb-201f294cec72",
- "name": "UDP Standalone Key",
- "version": "10.0",
- "value": "Sample Value",
- "is_additional_component": false,
- "activated_at": "2022-07-14T14:15:22Z",
- "deactivated_at": "2022-08-23T14:15:22Z"
}
]
}
]
}List Plans
List Plans
path Parameters
| tenant_id required | string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID |
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. Details are provided on the next page. (https://sdpf.ntt.com/about-sss/api-references/first-step/) |
Responses
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
500
Internal Server Error
get/v2/arcserve-udp/{tenant_id}/plans
https://soy-jp1-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/plans
https://soy-jp2-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/plans
https://soy-jp3-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/plans
https://soy-jp4-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/plans
https://soy-jp5-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/plans
https://soy-jp6-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/plans
https://soy-jp7-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/plans
https://soy-jp8-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/plans
https://soy-jp9-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/plans
Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
Copy
Expand all Collapse all {- "page": 1,
- "per_page": 30,
- "total_count": 2,
- "plans": [
- {
- "id": "00713021-9aea-41da-9a88-87760c08fa72",
- "name_en": "Arcserve Unified Data Protection (UDP) 9.0 Premium Plus Edition",
- "name_ja": "Arcserve Unified Data Protection (UDP) 9.0 Premium Plus Edition",
- "status": "Active",
- "type": "Baremetal Server / Hypervisor",
- "version": "9.0",
- "is_premium_plus": true,
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-08-09T14:15:22Z",
- "keys": [
- {
- "key_type_id": "3d39d83d-0fe5-4815-ba21-e09abae26a29",
- "name": "UDP Standalone Key",
- "version": "9.0",
- "is_additional_component": false,
- "number_of_keys": 2
}, - {
- "key_type_id": "25fecb0a-8aba-4797-ac73-0f11970301f1",
- "name": "Backup Socket Key",
- "version": "18.0",
- "is_additional_component": true,
- "number_of_keys": 1
}, - {
- "key_type_id": "6fa8f7c6-4084-4b0b-900e-9d408c618ae8",
- "name": "RHA Socket Key",
- "version": "16.5",
- "is_additional_component": true,
- "number_of_keys": 1
}
]
}, - {
- "id": "13c2cbc9-02f5-4bd7-b065-34a06e9666f1",
- "name_en": "Arcserve Unified Data Protection (UDP) ~8.0 Advanced Edition",
- "name_ja": "Arcserve Unified Data Protection (UDP) ~8.0 Advanced Edition",
- "status": "Active",
- "type": "Virtual Server",
- "version": "8.0",
- "is_premium_plus": false,
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-08-09T14:15:22Z",
- "keys": [
- {
- "key_type_id": "1ccf5faf-df3d-489d-940c-24f270957c08",
- "name": "UDP Server Key",
- "version": "8.0",
- "is_additional_component": false,
- "number_of_keys": 1
}, - {
- "key_type_id": "a4f09bd9-0325-42d9-88ab-68bd7259b6f2",
- "name": "UDP Standalone Key",
- "version": "8.0",
- "is_additional_component": false,
- "number_of_keys": 1
}
]
}
]
}List Orders
List Orders
path Parameters
| tenant_id required | string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID |
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. Details are provided on the next page. (https://sdpf.ntt.com/about-sss/api-references/first-step/) |
Responses
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
500
Internal Server Error
get/v2/arcserve-udp/{tenant_id}/orders
https://soy-jp1-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders
https://soy-jp2-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders
https://soy-jp3-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders
https://soy-jp4-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders
https://soy-jp5-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders
https://soy-jp6-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders
https://soy-jp7-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders
https://soy-jp8-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders
https://soy-jp9-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders
Response samples
- 200
- 400
- 401
- 403
- 500
Content type
application/json
Copy
Expand all Collapse all {- "page": 1,
- "per_page": 30,
- "total_count": 4,
- "orders": [
- {
- "id": "128afb92-4689-43d6-169b-e775405a6d80",
- "tenant_id": "c9a8c3e852f64840a67528d259880bad",
- "workspace_id": "ws0000588582",
- "email_address": "user1@example.com",
- "company_name": "Sample Company",
- "version": "8.0",
- "status": "Under Review",
- "is_deleted": false,
- "arcserve_order_id": null,
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-07-01T14:15:22Z"
}, - {
- "id": "69708992-7622-4a0a-45d7-04174343b576",
- "tenant_id": "c9a8c3e852f64840a67528d259880bad",
- "workspace_id": "ws0000588582",
- "email_address": "user1@example.com",
- "company_name": "Sample Company",
- "version": "10.0",
- "status": "Upgrade Under Review",
- "is_deleted": false,
- "arcserve_order_id": "Sample Order ID",
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-08-09T14:15:22Z"
}, - {
- "id": "f0ffe061-07d5-454f-958b-9a22a3e12a99",
- "tenant_id": "c9a8c3e852f64840a67528d259880bad",
- "workspace_id": "ws0000588582",
- "email_address": "user1@example.com",
- "company_name": "Sample Company",
- "version": "8.0",
- "status": "Active",
- "is_deleted": false,
- "arcserve_order_id": "Sample Order ID",
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-08-09T14:15:22Z"
}, - {
- "id": "6c4971b6-b0cb-447e-b506-fe3e4186e90c",
- "tenant_id": "c9a8c3e852f64840a67528d259880bad",
- "workspace_id": "ws0000588582",
- "email_address": "user1@example.com",
- "company_name": "Sample Company",
- "version": "9.0",
- "status": "Deleted",
- "is_deleted": true,
- "arcserve_order_id": "Sample Order ID",
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-08-09T14:15:22Z"
}
]
}Show Order
Show Order
path Parameters
| tenant_id required | string ^[0-9a-f]{32}$ Example: cab37c0a5c40450d9038463783b7d53e Tenant ID |
| order_id required | string <uuid> Order ID |
header Parameters
| X-Auth-Token required | string Example: e1b37cb197d84e69af37264fc0f167a33 Authentication token generated by Keystone. Details are provided on the next page. (https://sdpf.ntt.com/about-sss/api-references/first-step/) |
Responses
200
OK
400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
get/v2/arcserve-udp/{tenant_id}/orders/{order_id}
https://soy-jp1-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders/{order_id}
https://soy-jp2-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders/{order_id}
https://soy-jp3-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders/{order_id}
https://soy-jp4-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders/{order_id}
https://soy-jp5-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders/{order_id}
https://soy-jp6-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders/{order_id}
https://soy-jp7-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders/{order_id}
https://soy-jp8-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders/{order_id}
https://soy-jp9-ecl.api.ntt.com/v2/arcserve-udp/{tenant_id}/orders/{order_id}
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
Copy
Expand all Collapse all {- "order": {
- "id": "0ddaeffb-93e9-4b4f-aacd-543472ad206c",
- "tenant_id": "c9a8c3e852f64840a67528d259880bad",
- "workspace_id": "ws0000588582",
- "email_address": "user1@example.com",
- "company_name": "Sample Company",
- "version": "9.0",
- "status": "Active",
- "is_deleted": false,
- "arcserve_order_id": "Sample Order ID",
- "created_at": "2022-07-01T14:15:22Z",
- "updated_at": "2022-08-09T14:15:22Z"
}
}