Region

Get regions of the connected cloud service provider.

HTTP Request:

GET https://api.serveravatar.com/organizations/{organization}/cloud-server-providers/{cloudServerProvider}/regions

Curl Request example:

curl --request GET \
  --url "https://api.serveravatar.com/organizations/{organization}/cloud-server-providers/{cloudServerProvider}/regions" \
  --header 'Accept: application/json' \
  --header 'Authorization: <YOUR API TOKEN>'

Response:

• 200 (Ok)

[
  {
    "name": "Virginia",
    "country_code": "US",
    "value": "us-east-1",
    "available": true
  },
  {
    "name": "Ohio",
    "country_code": "US",
    "value": "us-east-2",
    "available": true
  },
  {
    "name": "Oregon",
    "country_code": "US",
    "value": "us-west-2",
    "available": true
  }
  ....
]

Organization Not Found

• 404 (Not Found)

{
  "message": "Organization not found!"
}

Server Provider Not Found

• 404 (Not Found)

{
  "message": "Server Provider not found!"
}

Server Error

• 500 (Internal Server Error)

{
  "message": "Something went really wrong!"
}

Availability Zone For Amazon Lightsail

Get Availability Zone of the Lightsail cloud service provider.

HTTP Request:

GET https://api.serveravatar.com/organizations/{organization}/cloud-server-providers/{cloudServerProvider}/regions?region=ap-south-1

Curl Request example:

curl --request GET \
  --url "https://api.serveravatar.com/organizations/{organization}/cloud-server-providers/{cloudServerProvider}/regions?region=ap-south-1" \
  --header 'Accept: application/json' \
  --header 'Authorization: <YOUR API TOKEN>'

Response:

• 200 (Ok)

{
  "region_zones": [
    {
      "zoneName": "ap-south-1a",
      "state": "available"
    },
    {
      "zoneName": "ap-south-1b",
      "state": "available"
    },
    {
      "zoneName": "ap-south-1c",
      "state": "available"
    }
  ],
  "region": "ap-south-1",
  "sizes": null
}

Organization Not Found

• 404 (Not Found)

{
    "message": "Organization not found!"
}

Server Provider Not Found

• 404 (Not Found)

{
    "message": "Server Provider not found!"
}

Server Error

• 500 (Internal Server Error)

{
    "message": "Something went really wrong!"
}