Account API v2 (Current)¶
This page contains all endpoints for the Account API v2.
Every call requires your API Key to be sent via the X-Reseller-Api-Key header. A 401 UNAUTHORIZED
status code will be sent back if credentials are missing. All the requests needs to have the port 9534.
-
GET/reseller/account/v2/clients/audited/deleted/¶ Get the list of audited deleted clients.
Status Codes: - 200 OK – Ok.
Example Response
-
POST/reseller/account/v2/active_directory/clients¶ Creates a new Active Directory Client.
The metadata entered must be valid JSON data.
Status Codes: - 200 OK – Success.
- 409 Conflict –
There is already a user with this user_name.
Example Request
{ "user_name": "user@example.com", "ldap_uri": "ldap://example.com", "ldap_userdn": "user@example.com" or "cn=user,dc=example,dc=com" }Example Response
{ "client": { "billing_status_ref": "new", "contacts": [ { "address": "777 77rd Ave", "address2": "", "city": "Моscow", "client_uuid": "ee9db902-f98a-47b9-9e58-86d7cd8a0330", "company": "Mail", "contact_type_ref": "primary", "country_ref": "ru", "deleted_date": null, "email": "example_user@mail.com", "first_name": "Example", "is_deleted": false, "language_ref": "ru", "last_name": "User", "locale_ref": "en-us", "phone": "15556666666", "phone_extension": "", "post_code": "", "region_ref": "", "uuid": "3ea91b2c-1611-4801-b152-2d060e17c56e" } ], "created_date": "2018-09-22T02:38:15.381500+00:00", "date_first_activated": null, "deleted_date": null, "is_activated": false, "is_deleted": false, "is_validated": true, "language_ref": "ru", "locale_ref": "en-ca", "metadata": {}, "projects": [ { "client_uuid": "ee9db902-f98a-47b9-9e58-86d7cd8a0330", "is_default": true, "name": "example_user@mail.com-aio-beeline", "provider_uuid": "69d65661-9b80-43b5-be7c-b9a32aa800e9", "uuid": "6a2314dd-dfec-4b91-b5ab-b0e3ab1056b1" } ], "reseller_uuid": "08e08c66-8a29-4ee8-a33e-bf5af1d68cf0", "user_name": "example_user@mail.com", "uuid": "ee9db902-f98a-47b9-9e58-86d7cd8a0330" } }
-
GET/reseller/account/v2/clients/clean/¶ Returns cleanable clients and resources.
Status Codes: - 200 OK – Ok.
-
GET/reseller/account/v2/clients/¶ Returns a list of Clients.
Note
The field “currency_code” is the client’s currency code. To get more information about the currency codes, refer to Available currencies for your reseller.
Status Codes: - 200 OK – Success.
Example Response
{ "clients": [ { "billing_status_ref": "awaiting_payment", "is_activated": false, "is_deleted": false, "is_validated": false, "language_ref": "en", "locale_ref": "en-ca", "reseller_uuid": "08e08c66-8a29-4ee8-a33e-bf5af1d68cf0", "user_name": "vladilen_74@rao.ru", "uuid": "f9712c75-0776-4612-9b79-c491f4d3d3c5", "currency_code": "USD" }, { "billing_status_ref": "awaiting_payment", "is_activated": false, "is_deleted": false, "is_validated": false, "language_ref": "en", "locale_ref": "en-ca", "reseller_uuid": "08e08c66-8a29-4ee8-a33e-bf5af1d68cf0", "user_name": "mqcysjjyfc1@mailinator.com", "uuid": "9801826d-8b92-45cf-90b6-333b1512a81f", "currency_code": "USD" }, { "billing_status_ref": "awaiting_payment", "is_activated": true, "is_deleted": false, "is_validated": true, "language_ref": "ru", "locale_ref": "en-ca", "reseller_uuid": "08e08c66-8a29-4ee8-a33e-bf5af1d68cf0", "user_name": "sidorovfilaret@ao.edu", "uuid": "06661a92-a711-417a-b49e-64637ddaeaa0", "currency_code": "EUR" } ] }
-
POST/reseller/account/v2/clients/¶ Creates a new Client. The personal information entered will be used to create the primary contact information for this client. If reseller has the auto_activate_account enabled the account will be activated.
The allow_ext_network field defines weather to add an external floating IP to the default router of the default project of the client being created. Default value is True.
Note
- The metadata entered must be valid JSON data.
- The user_name entered must be lowercase.
- The field “currency_code” defines the client’s currency. Defaults to the reseller’s currency. To get more information about the currency codes, refer to Available currencies for your reseller.
- If the parameter for the password is not sent, a random password will be generated.
Status Codes: - 400 Bad Request – Bad request.
- 200 OK –
Success.
Example Request
{ "user_name": "example_user@mail.com", "first_name": "Example", "last_name": "User", "company": "Mail", "address": "777 77rd Ave", "city": "Моscow", "state_ref": "ru-mow", "country_ref": "ru", "language_ref": "ru", "zip": "103426", "phone": "15556666666", "phone_extension": "", "password": "7b5JogdiVAkx", "metadata": { }, "allow_ext_network": true, "currency_code": "EUR", "stripe_customer_id": "cus_P2mzjOTb9fRaicz" }
Example Response
{ "client": { "currency_code": "EUR", "billing_status_ref": "new", "contacts": [ { "address": "777 77rd Ave", "address2": "", "city": "Моscow", "client_uuid": "ee9db902-f98a-47b9-9e58-86d7cd8a0330", "company": "Mail", "contact_type_ref": "primary", "country_ref": "ru", "deleted_date": null, "email": "example_user@mail.com", "first_name": "Example", "is_deleted": false, "language_ref": "ru", "last_name": "User", "locale_ref": "en-us", "phone": "15556666666", "phone_extension": "", "post_code": "", "region_ref": "", "uuid": "3ea91b2c-1611-4801-b152-2d060e17c56e" } ], "created_date": "2018-09-22T02:38:15.381500+00:00", "date_first_activated": null, "deleted_date": null, "is_activated": false, "is_deleted": false, "is_validated": true, "language_ref": "ru", "locale_ref": "en-ca", "metadata": {}, "projects": [ { "client_uuid": "ee9db902-f98a-47b9-9e58-86d7cd8a0330", "is_default": true, "name": "example_user@mail.com-aio-beeline", "provider_uuid": "69d65661-9b80-43b5-be7c-b9a32aa800e9", "uuid": "6a2314dd-dfec-4b91-b5ab-b0e3ab1056b1" } ], "reseller_uuid": "08e08c66-8a29-4ee8-a33e-bf5af1d68cf0", "user_name": "example_user@mail.com", "uuid": "ee9db902-f98a-47b9-9e58-86d7cd8a0330" } }
-
PATCH/reseller/account/v2/clients/(client_uuid)/providers/external/disable/¶ Disable the received client to see external providers in a Federated environment.
Parameters: - client_uuid – UUID of the Client.
Status Codes: - 202 Accepted – Request accepted.
-
PATCH/reseller/account/v2/clients/(client_uuid)/providers/external/enable/¶ Enable the received client to see external providers in a Federated environment.
Parameters: - client_uuid – UUID of the Client.
Status Codes: - 202 Accepted – Request accepted.
-
GET/reseller/account/v2/clients/(client_uuid)/providers/(provider_uuid)/resources/¶ Returns a list of Resources used by a given Client on a given Provider, separated by Projects.
Parameters: - client_uuid – ID of the Client to retrieve Resources for.
- provider_uuid – ID of the Provider to get used Resources on.
Status Codes: - 200 OK – Success.
Example Response
{ "provider": { "country_ref": "ca", "name": "Ormuco-MTL", "projects": [ { "client_uuid": "b3826036-4541-4193-b56f-f0c52fb42eae", "is_default": true, "name": "js.mantilla128@gmail.com-Ormuco-MTL", "provider_uuid": "9e45dd64-a2ff-4da3-b70c-cd34c79a1c", "resources": { "dns_zones": [ { "cloud_dns_zone_id":"0649152d-9f18-45a2- 8812-7630b2b099c2", "ended_date": null, "name": "dadsad.com.", "started_date": "2018-08-01T19:50:15+00:00" } ], "floating_ips": [ { "cloud_floating_ip_id": "02f413d3-a4d6- 4eb2-97e9- f999d95b70ef", "ended_date": null, "ip_address": "192.207.60.134", "started_date":"2018-10-02T21:18:22+00:00" }, { "cloud_floating_ip_id": "7387bc8e-4e47- 4409-9350- 15bfad33d0e4", "ended_date": null, "ip_address": "192.207.60.25", "started_date":"2018-10-01T23:11:42+00:00" }, { "cloud_floating_ip_id": "bc0d88a3-536f- 469f-8d9c- 0cb1d5820e6a", "ended_date": null, "ip_address": "192.207.60.205", "started_date":"2018-10-02T21:20:54+00:00" }, { "cloud_floating_ip_id": "c20699fc-75c2- 4bec-a480- a9207cd8c975", "ended_date": null, "ip_address": "192.207.60.76", "started_date":"2018-10-01T23:01:44+00:00" } ], "load_balancers": [], "network_bandwidth": { "bytes_in": 0, "bytes_out": 0, "bytes_total": 0 }, "object_storage": { "bytes_used": 0, "container_count": 0, "last_sample_date":"2018-10-02T2:40:00+00:00", "object_count": 0 }, "server_snapshots": [ { "byte_size": 10737418240, "cloud_server_id": "3e306ed0-4414-45d0- b6e0-918f6b37c394", "cloud_server_snapshot_id": "8315a4bb- 1293-4905- abc1-a4c7f2", "ended_date": null, "name": "test sn", "started_date":"2018-10-02T21:12:50+00:00" } ], "servers": [ { "cloud_server_id": "b05e002d-15e4- 4791-b421- 57317168856c", "ended_date": null, "flavor": "general.mega.yul.linux", "name": "ubuntu-14.04.general.mega.yul. linux", "started_date":"2018-09-04T16:47:02+00:00" }, { "cloud_server_id": "fbfc4df5-c341-4e40- 948c-991bfb4d793a", "ended_date": null, "flavor": "general.pico.yul.windows", "name": "app-ormucovpn-594039a6-77d0-4f40 -ae82-faec97cddb43", "started_date":"2018-10-02T21:22:08+00:00" }, { "cloud_server_id": "3e306ed0-4414-45d0- b6e0-918f6b37c394", "ended_date": null, "flavor": "general.mega.yul.linux", "name": "test", "started_date":"2018-10-01T22:58:09+00:00" }, { "cloud_server_id": "3aa4df8a-939e-40fb- 9f39-3a820dc305ae", "ended_date": null, "flavor": "general.micro.yul.linux", "name": "app-sonarqube-55c4e42a-a6de-45b0- 8559-f65943823873", "started_date": "2018-10-02T21:18:16+00:00" } ], "volume_snapshots": [ { "cloud_volume_id": "78cd5943-63ab-474e- a214-c8ff9dd2d464", "cloud_volume_snapshot_id": "af8dd-0737- 4c52-8c24- 4e843fc10ccc", "ended_date": null, "gb_size": 0, "name": "test volume snapshot", "started_date": "2018-10-02T21:22:57+00:00" } ], "volumes": [ { "cloud_volume_id": "d62383-1c85-40aa-bde1- 5ce56395b29a", "ended_date": null, "gb_size": 10, "name": "test volume", "started_date": "2018-10-02T21:22:47+ 00:00", "volume_type": "4943950f-2238-4197-b349- 081e2c9bd8d8" } ] }, "uuid": "14a85e42-87d4-4e48-bf50-67e1fa144b5c" }, { "client_uuid": "b3826036-4541-4193-b56f-f0c52fb42eae", "is_default": false, "name": "test 2+", "provider_uuid": "9e45dd64-a2ff-4da3-b70c-cd34c791c", "resources": { "dns_zones": [], "floating_ips": [], "load_balancers": [], "network_bandwidth": { "bytes_in": 0, "bytes_out": 0, "bytes_total": 0 }, "object_storage": {}, "server_snapshots": [], "servers": [], "volume_snapshots": [], "volumes": [] }, "uuid": "fe36b3a3-012c-48b7-a85a-76769af8bd42" } ], "uuid": "9e45dd64-a2ff-4da3-b70c-cd34c7962a1c" } }
-
PATCH/reseller/account/v2/clients/(client_uuid)/projects/quotas¶ Update the limit of projects a user can create. You can only modify the limit of projects if you own the client and if the client has less projects than the quota you’re trying to set.
Parameters: - client_uuid – UUID of the Client.
Status Codes: - 200 OK – Success.
- 400 Bad Request – Bad request.
-
GET/reseller/account/v2/clients/(client_uuid)/projects/(project_uuid)/resources/¶ Returns a list of Resources used by a given Client on a given Project.
Parameters: - client_uuid – ID of the Client to retrieve Resources for.
- project_uuid – ID of the Project to get used Resources on.
Status Codes: - 200 OK – Success.
Example Response
{ "project": { "client_uuid": "b3826036-4541-4193-b56f-f0c52fb42eae", "is_default": true, "name": "js.mantilla128@gmail.com-Ormuco-MTL", "provider_uuid": "9e45dd64-a2ff-4da3-b70c-cd34c7962a1c", "resources": { "dns_zones": [ { "cloud_dns_zone_id": "0649152d-9f18-45a2-8812- 7630b2b099c2", "ended_date": null, "name": "dadsad.com.", "started_date": "2018-08-01T19:50:15+00:00" } ], "floating_ips": [ { "cloud_floating_ip_id": "02f413d3-a4d6-4eb2-97e9- f999d95b70ef", "ended_date": null, "ip_address": "192.207.60.134", "started_date": "2018-10-02T21:18:22+00:00" }, { "cloud_floating_ip_id": "7387bc8e-4e47-4409-9350- 15bfad33d0e4", "ended_date": null, "ip_address": "192.207.60.25", "started_date": "2018-10-01T23:11:42+00:00" }, { "cloud_floating_ip_id": "bc0d88a3-536f-469f-8d9c- 0cb1d5820e6a", "ended_date": null, "ip_address": "192.207.60.205", "started_date": "2018-10-02T21:20:54+00:00" }, { "cloud_floating_ip_id": "c20699fc-75c2-4bec-a480- a9207cd8c975", "ended_date": null, "ip_address": "192.207.60.76", "started_date": "2018-10-01T23:01:44+00:00" } ], "load_balancers": [], "network_bandwidth": { "bytes_in": 0, "bytes_out": 0, "bytes_total": 0 }, "object_storage": { "bytes_used": 0, "container_count": 0, "last_sample_date": "2018-10-02T20:40:00+00:00", "object_count": 0 }, "server_snapshots": [ { "byte_size": 10737418240, "cloud_server_id": "3e306ed0-4414-45d0-b6e0- 918f6b37c394", "cloud_server_snapshot_id": "8315a4bb-1293-4905- abc1-a4c719047cf2", "ended_date": null, "name": "test sn", "started_date": "2018-10-02T21:12:50+00:00" } ], "servers": [ { "cloud_server_id": "b05e002d-15e4-4791-b421- 57317168856c", "ended_date": null, "flavor": "general.mega.yul.linux", "name": "ubuntu-14.04.general.mega.yul.linux", "started_date": "2018-09-04T16:47:02+00:00" }, { "cloud_server_id": "fbfc4df5-c341-4e40-948c- 991bfb4d793a", "ended_date": null, "flavor": "general.pico.yul.windows", "name": "app-ormucovpn-594039a6-77d0-4f40-ae82- faec97cddb43", "started_date": "2018-10-02T21:22:08+00:00" }, { "cloud_server_id": "3e306ed0-4414-45d0-b6e0- 918f6b37c394", "ended_date": null, "flavor": "general.mega.yul.linux", "name": "test", "started_date": "2018-10-01T22:58:09+00:00" }, { "cloud_server_id": "3aa4df8a-939e-40fb-9f39- 3a820dc305ae", "ended_date": null, "flavor": "general.micro.yul.linux", "name": "app-sonarqube-55c4e42a-a6de-45b0-8559- f65943823873", "started_date": "2018-10-02T21:18:16+00:00" } ], "volume_snapshots": [ { "cloud_volume_id": "78cd5943-63ab-474e-a214- c8ff9dd2d464", "cloud_volume_snapshot_id": "af8dfb4d-0737-4c52- 8c24-4e843fc10ccc", "ended_date": null, "gb_size": 0, "name": "test volume snapshot", "started_date": "2018-10-02T21:22:57+00:00" } ], "volumes": [ { "cloud_volume_id": "dc162383-1c85-40aa-bde1- 5ce56395b29a", "ended_date": null, "gb_size": 10, "name": "test volume", "started_date": "2018-10-02T21:22:47+00:00", "volume_type": "4943950f-2238-4197-b349- 081e2c9bd8d8" } ] }, "uuid": "14a85e42-87d4-4e48-bf50-67e1fa144b5c" } }
-
PATCH/reseller/account/v2/clients/(client_uuid)/projects/(project_uuid)/quotas¶ Update multiple quotas for a project belonging to a client. This endpoint let you edit quotas for the services compute and block_storage.
Possible quotas values by services:
Compute:
- cores: Maximum amount of total server cores (VCPUs) allowed per project.
- fixed_ips: Maximum amount of fixed IP addresses allowed per project. This number must be equal to or greater than the number of allowed servers (instances).
- instances: Maximum amount of servers (instances) allowed per project.
- key_pairs: Maximum amount of key pairs allowed per project.
- ram: Maximum amount of megabytes of server ram allowed per project (in MB).
Block Storage:
- gigabytes: Maximum amount of gigabytes a project can have in total volumes size.
- snapshots: Maximum amount of snapshots a project can have.
- volumes: Maximum amount of volumes a project can have.
Networking:
- floatingip: The number of floating IP addresses allowed for each project. A value of -1 means no limit.
- health_monitor: The number of load balancer health monitors allowed for each project. A value of -1 means no limit.
- listener: The number of load balancer listeners allowed for each project. A value of -1 means no limit.
- loadbalancer: The number of load balancers allowed for each project. A value of -1 means no limit.
- member: The number of load balancer members allowed for each project. A value of -1 means no limit.
- network: The number of networks allowed for each project. A value of -1 means no limit.
- pool: The number of load balancer pools allowed for each project. A value of -1 means no limit.
- port: The number of ports allowed for each project. A value of -1 means no limit.
- router: The number of routers allowed for each project. A value of -1 means no limit.
- security_group: The number of security groups allowed for each project. A value of -1 means no limit.
- security_group_rule: The number of security group rules allowed for each project. A value of -1 means no limit.
- subnet: The number of subnets allowed for each project. A value of -1 means no limit.
Parameters: - client_uuid – ID of the Client to be updated.
- project_uuid –
ID of the project to be updated.
Example Request
{ "block_storage": { "gigabytes": 1000, "snapshots": 15, "volumes": 30 }, "compute": { "cores": 95, "fixed_ips": -1, "instances": 200, "key_pairs": 100, "ram": 440000 }, "networking": { "floatingip": 100, "health_monitor": 100, "listener": 101, "loadbalancer": 21, "member": 101, "network": 201, "pool": 101, "port": 501, "router": 31, "security_group": -1, "security_group_rule": 301, "subnet": 101 } }
Example Response
Status Codes: - 202 Accepted – Success.
-
PATCH/reseller/account/v2/clients/(client_uuid)/unsuspend/¶ Unsuspend a Client. This will restore the client’s access to both Portal and the Cloud APIs. The servers of the client will be restored. Accesses to the other cloud resources of the client will be restored as well.
The cloud will attempt to restore the servers in the same state they were before they were converted to images. Due to the nature of the operation it is not guaranteed that every processes on the restored servers will resume functionality without intervention.
If the client has projects on different locations, these will be included in the response.
Parameters: - client_uuid – ID of the Client to be reactivate.
Status Codes: - 207 Multi Status – Multi-Status.
Example Response
-
GET/reseller/account/v2/clients/(client_uuid)/providers/¶ Returns Providers currently used by a given Client as well as all Projects in each Provider belonging to the Client.
Parameters: - client_uuid – ID of the Client to retrieve Providers for.
Status Codes: - 200 OK – Success.
Example Response
{ "providers": [ { "country_ref": "ca", "name": "Ormuco-MTL", "projects": [], "uuid": "9e45dd64-a2ff-4da3-b70c-cd34c7962a1c" } ] }
-
GET/reseller/account/v2/clients/(client_uuid)/resources/¶ Returns a list of Resources used by a given Client separated by Provider and Project.
Parameters: - client_uuid – ID of the Client to retrieve Resources for.
Status Codes: - 200 OK – Success.
Example Response
{ "providers": [ { "country_ref": "ca", "name": "Ormuco-MTL", "projects": [ { "client_uuid": "b3826036-4541-4193-b56f-f0c5fb2e", "is_default": true, "name": "js.mantilla128@gmail.com-Ormuco-MTL", "provider_uuid": "9e45dd64-a2ff-4da3-b70c-cd341c", "resources": { "dns_zones": [ { "cloud_dns_zone_id": "0649152d-9f18- 45a2-8812- 7630b2b099c2", "ended_date": null, "name": "dadsad.com.", "started_date": "2018-08-01T19:50: 15+00:00" } ], "floating_ips": [ { "cloud_floating_ip_id": "02f413d3- a4d6-4eb2- 97e9- f999d95b70ef", "ended_date": null, "ip_address": "192.207.60.134", "started_date": "2018-10-02T21:18:22+ 00:00" }, { "cloud_floating_ip_id": "7387bc8e- 4e47-4409- 9350- 15bfad33d0e4", "ended_date": null, "ip_address": "192.207.60.25", "started_date": "2018-10-01T23:11:42+ 00:00" }, { "cloud_floating_ip_id": "bc0d88a-536f- 469f-8d9c- 0cb1d5820e6a", "ended_date": null, "ip_address": "192.207.60.205", "started_date": "2018-10-02T21:20:54+ 00:00" }, { "cloud_floating_ip_id": "c2099fc-75c2- 4bec-a480- a9207cd8c975", "ended_date": null, "ip_address": "192.207.60.76", "started_date": "2018-10-01T23:01:44+ 00:00" } ], "load_balancers": [], "network_bandwidth": { "bytes_in": 0, "bytes_out": 0, "bytes_total": 0 }, "object_storage": { "bytes_used": 0, "container_count": 0, "last_sample_date": "2018-10-02T20:40: 00+00:00", "object_count": 0 }, "server_snapshots": [ { "byte_size": 10737418240, "cloud_server_id": "3e306ed0-4414- 45d0-b6e0- 918f6b37c394", "cloud_server_snapshot_id": "8315a4bb- 1293- 4905- abc1- a4c7190", "ended_date": null, "name": "test sn", "started_date": "2018-10-02T21:12:50+ 00:00" } ], "servers": [ { "cloud_server_id": "b05e002d-15e4- 4791-b421- 57317168856c", "ended_date": null, "flavor": "general.mega.yul.linux", "name": "ubuntu-14.04.general.mega. yul.linux", "started_date": "2018-09-04T16:47:02+ 00:00" }, { "cloud_server_id": "fbfc4df5-c341- 4e40-948c- 991bfb4d793a", "ended_date": null, "flavor": "general.pico.yul.windows", "name": "app-ormucovpn-594039a6-77d0- 4f40-ae82-faec97cddb43", "started_date": "2018-10-02T21:22:08+ 00:00" } ], "volume_snapshots": [ { "cloud_volume_id": "78cd5943-63ab- 474e-a214- c8ff9dd2d464", "cloud_volume_snapshot_id": "af8dfb4d- 0737-4c2- 8c24- 4e843fc", "ended_date": null, "gb_size": 0, "name": "test volume snapshot", "started_date": "2018-10-02T21:22:57+ 00:00" } ], "volumes": [ { "cloud_volume_id": "dc162383-1c85- 40aa-bde1- 5ce56395b29a", "ended_date": null, "gb_size": 10, "name": "test volume", "started_date": "2018-10-02T21:22:47+ 00:00", "volume_type": "4943950f-2238-4197- b349-081e2c9bd8d8" } ] }, "uuid": "14a85e42-87d4-4e48-bf50-67e1fa144b5c" }, { "client_uuid": "b3826036-4541-4193-b56f-f0c52eae", "is_default": false, "name": "test 2+", "provider_uuid": "9e45dd64-a2ff-4da3-b70c-cda1c", "resources": { "dns_zones": [], "floating_ips": [], "load_balancers": [], "network_bandwidth": { "bytes_in": 0, "bytes_out": 0, "bytes_total": 0 }, "object_storage": {}, "server_snapshots": [], "servers": [], "volume_snapshots": [], "volumes": [] }, "uuid": "fe36b3a3-012c-48b7-a85a-76769af8bd42" } ], "uuid": "9e45dd64-a2ff-4da3-b70c-cd34c7962a1c" } ] }
-
GET/reseller/account/v2/clients/(client_uuid)/contacts/(contact_uuid)/¶ Returns the details of a specific Contact.
Parameters: - client_uuid – ID of the Client the contact belongs to.
- contact_uuid – ID of the Contact to retrieve.
Status Codes: - 200 OK – Success.
Example Response
{ "contact": { "address": "1835 73rd Ave", "address2": "", "city": "Montreal", "client_uuid": "a5fe41d9-cee9-461b-b786-1b37272b5016", "company": "Mike Row Soft", "contact_type_ref": "primary", "country_ref": "ca", "deleted_date": null, "email": "api.client@integration.com", "first_name": "James", "is_deleted": false, "language_ref": "en", "last_name": "Bond", "locale_ref": "en-ca", "phone": "15556666666", "phone_extension": "", "post_code": "H3R5A1", "region_ref": "ca-qc", "uuid": "341e5029-c51e-4660-a471-ff6c9fa79db9" } }
-
PATCH/reseller/account/v2/clients/(client_uuid)/contacts/(contact_uuid)/¶ Update a Contact’s general information.
Parameters: - client_uuid – ID of the Client the contact belongs to.
- contact_uuid – ID of the Contact to be updated.
Status Codes: - 200 OK –
Success.
Example Request
{ "first_name": "James", "contact_type_ref": "billing", "last_name": "Bond", "address1": "1835 73rd Ave", "address2": "", "city": "Medina", "state_ref": "us-wa", "country_ref": "us", "zip": "98039", "phone": "15556666666", "phone_extension": "", "locale_ref": "en-us" }
Example Response
{ "contact": { "address": "1835 73rd Ave", "address2": "", "city": "Medina", "client_uuid": "b3826036-4541-4193-b56f-f0c52fb42eae", "company": null, "contact_type_ref": "billing", "country_ref": "us", "deleted_date": null, "email": "example@mail.com", "first_name": "James", "is_deleted": false, "language_ref": "en", "last_name": "Bond", "locale_ref": "en-us", "phone": "15556666666", "phone_extension": "", "post_code": null, "region_ref": null, "uuid": "4f212a5d-49ed-4a69-bb51-5ece509998b9" } }
-
DELETE/reseller/account/v2/clients/(client_uuid)/contacts/(contact_uuid)/¶ Delete a Contact, effectively from a Client. This action is not reversible.
Note that you can not delete the ‘primary’ Contact.
Parameters: - client_uuid – ID of the Client the contact belongs to.
- contact_uuid – ID of the Contact to be deleted.
Status Codes: - 202 Accepted – Success.
-
PATCH/reseller/account/v2/clients/(client_uuid)/password/¶ Update password for a client.
Parameters: - client_uuid – UUID of the client to update password for.
Response JSON Object: - old_password (str) – Old password
- new_password (str) – New password
- confirm_password (str) – New password confirmation
Status Codes: - 200 OK – Success.
- 400 Bad Request – Passwords do not match or password is too short or password does not follow the acceptable pattern.
- 401 Unauthorized – Old password is incorrect.
- 404 Not Found –
Client not found; Client does not belong to reseller.
Example Request
{ "old_password": "abc123", "new_password": "321cba", "confirm_password": "321cba" }
-
PATCH/reseller/account/v2/clients/(client_uuid)/activate/¶ Activate a Client, granting them access to the Openstack API and Portal.
The allow_ext_network field defines weather to add an external floating IP to the default router of the default project of the client being created. Default value is True.
Parameters: - client_uuid – ID of the Client to be activated.
Status Codes: - 200 OK – Success.
- 409 Conflict – Conflict. The client is already deleted.
Example Request
{ "allow_ext_network": true }
Example Response
{ "client": { "billing_status_ref": "activated_by_reseller", "contacts": [ { "address": "777 77rd Ave", "address2": "", "city": "Моscow", "client_uuid": "13f81e7a-a0c4-49a9-94a5-4b24a02ee508", "company": "Mail", "contact_type_ref": "primary", "country_ref": "ru", "deleted_date": null, "email": "example_user@mail.com", "first_name": "Example", "is_deleted": false, "language_ref": "en", "last_name": "User", "locale_ref": "en-us", "phone": "15556666666", "phone_extension": "", "post_code": "", "region_ref": "", "uuid": "9117169b-2255-4a1d-a4b2-597937d22283" } ], "created_date": "2018-10-02T14:56:31.563100+00:00", "date_first_activated": "2018-10-02T15:01:36.944006+00:00", "deleted_date": null, "is_activated": true, "is_deleted": false, "is_validated": true, "language_ref": "en", "locale_ref": "en-ca", "metadata": {}, "projects": [ { "client_uuid": "13f81e7a-a0c4-49a9-94a5-4b24a02ee508", "is_default": true, "name": "example_user@mail.com-Ormuco-MTL", "provider_uuid": "9e45dd64-a2ff-4da3-b70c-cd34c796c", "uuid": "73eac40f-8cfd-4096-abb0-cff4c5977f3f" } ], "reseller_uuid": "66b392e7-85c9-416b-bb5b-af42ce45533c", "user_name": "example_user@mail.com", "uuid": "13f81e7a-a0c4-49a9-94a5-4b24a02ee508" } }
-
GET/reseller/account/v2/clients/(client_uuid)/projects/¶ Returns a list of Projects for the given Client.
Parameters: - client_uuid – ID of the Client to retrieve Projects for.
Status Codes: - 200 OK – Success.
Example Response
{ "projects": [ { "client_uuid": "7b8985ae-2dcb-43c9-baea-8461ae9a69be", "is_default": false, "name": "example project", "provider_uuid": "9e45dd64-a2ff-4da3-b70c-cd34c7962a1c", "uuid": "01e6ecc5-113c-4570-9d32-366430e4afa7" }, { "client_uuid": "7b8985ae-2dcb-43c9-baea-8461ae9a69be", "is_default": true, "name": "example_user1@mail.com-Ormuco-MTL", "provider_uuid": "9e45dd64-a2ff-4da3-b70c-cd34c7962a1c", "uuid": "86ebbcd9-0cda-4e81-ac08-c0037bd5d3c2" } ] }
-
GET/reseller/account/v2/clients/(client_uuid)/contacts/¶ Returns a list of a Client’s Contacts.
Parameters: - client_uuid – ID of the Client to get Contacts for.
Status Codes: - 200 OK – Success.
Example Response
{ "contacts": [ { "contact_uuid": "d65deff1-03e0-4538-969f-6384e8fde6e6", "contact_type_ref": "primary", "first_name": "Bill", "last_name": "Gates", "address1": "1835 73rd Ave", "address2": "", "city": "Medina", "state_ref": "us-wa", "country_ref": "us", "zip": "98039", "phone": "15556666666", "phone_extension": "", "locale_ref": "en-us" }, { "contact_uuid": "eee345f1-03e0-4538-969f-6384e8fde6e6", "contact_type_ref": "billing", "first_name": "James", "last_name": "Bond", "address1": "1835 73rd Ave", "address2": "", "city": "Medina", "state_ref": "us-wa", "country_ref": "us", "zip": "98039", "phone": "15556666666", "phone_extension": "", "locale_ref": "en-us" }, { "contact_uuid": "ddd465f1-03e0-4538-969f-6384e8fde6e6", "contact_type_ref": "billing", "first_name": "Jack", "last_name": "Johnson", "address1": "1835 73rd Ave", "address2": "", "city": "Medina", "state_ref": "us-wa", "country_ref": "us", "zip": "98039", "phone": "15556666666", "phone_extension": "", "locale_ref": "en-us" } ] }
-
POST/reseller/account/v2/clients/(client_uuid)/contacts/¶ Creates a new Client Contact. Note that a Client can only have one ‘primary’ Contact.
Parameters: - client_uuid – ID of the Client the contact will belong to.
Status Codes: - 200 OK –
Success.
Example Request
{ "contact_type_ref": "billing", "first_name": "James", "last_name": "Bond", "address": "1835 73rd Ave", "city": "Medina", "state_ref": "us-wa", "country_ref": "us", "zip": "98039", "phone": "15556666666", "phone_extension": "", "locale_ref": "en-us", "language_ref": "{{language_ref}}", "email": "example@mail.com" }
Example Response
{ "contact": { "address": "1835 73rd Ave", "address2": null, "city": "Medina", "client_uuid": "b3826036-4541-4193-b56f-f0c52fb42eae", "company": null, "contact_type_ref": "billing", "country_ref": "us", "email": "example@mail.com", "first_name": "James", "is_deleted": false, "language_ref": "en", "last_name": "Bond", "locale_ref": "en-us", "phone": "15556666666", "phone_extension": "", "post_code": null, "region_ref": null, "uuid": "4f212a5d-49ed-4a69-bb51-5ece509998b9" } }
-
PATCH/reseller/account/v2/clients/(client_uuid)/suspend/¶ Deactivate a Client. This will not delete the Client but simply deactivate or suspend their access to the Cloud and their resources until further notice. The servers of the clients will be shut down and shelved to avoid taking up space in the Cloud. Other resources of the users may still remain on the cloud, albeit inaccessible, and take up space that could be used for other clients. If the client has projects on different locations, these will be included in the response.
Consider deactivation as a temporary measure used when sorting out the situation of a Client. A client should not be deactivated indefinitely, it should either be reactivated or deleted.
Parameters: - client_uuid – ID of the Client to be deactivate.
Status Codes: - 207 Multi Status – Multi-Status.
Example Response
-
PATCH/reseller/account/v2/clients/(client_uuid)/nontest/¶ Marks the received client as a non Test Account. Test Accounts will be ignored in reseller metrics calculation.
Parameters: - client_uuid – UUID of the Client to be marked as non-test account.
Status Codes: - 202 Accepted – Request accepted.
-
GET/reseller/account/v2/clients/(client_uuid)/actions¶ Get audited actions for the received client.
Parameters: - client_uuid – UUID of the Client.
Example Response
Status Codes: - 200 OK – Ok.
- 404 Not Found – Client not found; Client does not belong to reseller.
-
PATCH/reseller/account/v2/clients/(client_uuid)/reset¶ Resets password of a client. This request allows to reset the user password of the client and sends an email to the client with the new password generated.
Parameters: - client_uuid – Public ID of the Client.
Status Codes: - 200 OK – OK.
- 403 Forbidden – reseller user does not have permissions to perform this action.
-
PATCH/reseller/account/v2/clients/(client_uuid)/info¶ edit a client’s information
-
PATCH/reseller/account/v2/clients/(client_uuid)/test/¶ Marks the received client as a non Test Account. Test Accounts will be ignored in reseller metrics calculation.
Parameters: - client_uuid – UUID of the Client to be marked as test account.
Status Codes: - 202 Accepted – Request accepted.
-
GET/reseller/account/v2/clients/(client_uuid)/¶ Returns the details of a specific Client.
Parameters: - client_uuid – ID of the Client to be retrieved.
Note
The field “currency_code” is the client’s currency code. To get more information about the currency codes, refer to Available currencies for your reseller.
Status Codes: - 200 OK – Success.
Example Response
{ "client": { "billing_status_ref": "new", "contacts": [ { "address": "777 77rd Ave", "address2": "", "city": "Моscow", "client_uuid": "f9712c75-0776-4612-9b79-c491f4d3d3c5" "company": "Mail", "contact_type_ref": "primary", "country_ref": "ru", "deleted_date": null, "email": "example_user@mail.com", "first_name": "Example", "is_deleted": false, "language_ref": "ru", "last_name": "User", "locale_ref": "en-us", "phone": "15556666666", "phone_extension": "", "post_code": "", "region_ref": "", "uuid": "3ea91b2c-1611-4801-b152-2d060e17c56e" } ], "created_date": "2018-09-22T02:38:15.381500+00:00", "date_first_activated": null, "deleted_date": null, "is_activated": false, "is_deleted": false, "is_validated": true, "language_ref": "ru", "locale_ref": "en-ca", "metadata": {}, "projects": [ { "client_uuid": "ee9db902-f98a-47b9-9e58-86d7cd8a0330", "is_default": true, "name": "example_user@mail.com-aio-beeline", "provider_uuid": "69d65661-9b80-43b5-be7c-b9a32aa800e9", "uuid": "6a2314dd-dfec-4b91-b5ab-b0e3ab1056b1" } ], "reseller_uuid": "08e08c66-8a29-4ee8-a33e-bf5af1d68cf0", "user_name": "example_user@mail.com", "uuid": "ee9db902-f98a-47b9-9e58-86d7cd8a0330", "currency_code": "USD" } }
-
DELETE/reseller/account/v2/clients/(client_uuid)/¶ Delete a Client, effectively disabling the account and removing access to the Cloud. This action is not reversible. If the client has projects on different locations, these will be included in the response.
Parameters: - client_uuid – ID of the Client to be deleted.
Status Codes: - 207 Multi Status – Multi-Status.
Example Response
-
GET/reseller/account/v2/server/(cloud_server_id)¶ Gets the server information by openstack server id. :param cloud_server_id: Openstack server id.
Status Codes: - 200 OK – Request accepted.
- 404 Not Found – Reseller doesnt exists.
- 404 Not Found – Openstack server id doesnt exists.
Example Response
{ "cloud_server_id": "c12016b1-00f1-4af9-808d-956c0b6c95f5", "cpu_cores": 1, "cpu_type": "Virtualized", "created_date": "2023-06-15T17:46:37+00:00", "deleted_date": null, "flavor_name": "general.pico.uat.linux", "internal_server_id": "c12016b1-00f1-4af9-808d-956c0b6c95f5", "name": "johann-instance-test-t18454", "networks": [ { "fixed_ip": "10.142.122.51", "floating_ip": null, "name": "alexnattestnet" }, { "fixed_ip": "192.168.3.170", "floating_ip": "185.121.132.130", "name": "default-network" } ], "os_name": "ubuntu-18.04-amd64", "os_version": "18.04", "ram": "512 MB", "volumes": [ { "name": "johann-test-volume-inst-01", "size": "1 GB", "type": "HDD based storage", "used": "0G" }, { "name": "johann-test-volume-inst-02", "size": "2 GB", "type": "HDD based storage", "used": "0G" } ] }