Application programming interfaces (APIs)

The Catalyst Cloud follows the “API first” design principle. Every service we implement on the Catalyst Cloud is first made available via an API, then the command line interface (CLI) and finally the dashboard. As a result, it often takes three to six months for a new feature or service to reach the dashboard.

Note

The API is rate limited to prevent one customer from denying access to other customers. When the rate limit is hit, the endpoint will return a standard HTTP error response (code 429), and a header indicating how much to back-off before retrying. Not all tools correctly implement backing off in response to this message.

API reference

The OpenStack API reference can be found at: https://docs.openstack.org/api-quick-start/index.html

Note

The OpenStack API complete reference guide covers versions of the APIs that are current, experimental and deprecated. Please make sure you are referring to the correct version of the API.

API endpoints

Once authenticated, you can obtain the service catalogue and the list of API endpoints on the current region from the identity service.

From the dashboard, you can find the endpoints under Access and Security, API endpoints.

From the command line tools, you can run openstack catalog list to list the services and API endpoints of the current region.

Endpoints for “nz-por-1”

Service

Endpoint

alarming

https://api.nz-por-1.catalystcloud.io:8042

cloudformation

https://api.nz-por-1.catalystcloud.io:8000/v1/

compute

https://api.nz-por-1.catalystcloud.io:8774/v2/%projectid%

computev3

https://api.nz-por-1.catalystcloud.io:8774/v3

container infra

https://api.nz-por-1.catalystcloud.io:9511/v1

database

https://api.nz-por-1.catalystcloud.io:8779/v1.0/%projectid%

identity

https://api.nz-por-1.catalystcloud.io:5000/

image

https://api.nz-por-1.catalystcloud.io:9292

metering

https://api.nz-por-1.catalystcloud.io:8777

network

https://api.nz-por-1.catalystcloud.io:9696/

object-store

https://object-storage.nz-por-1.catalystcloud.io:443/v1/AUTH_%projectid%

orchestration

https://api.nz-por-1.catalystcloud.io:8004/v1/%projectid%

ratingv2

https://api.nz-por-1.catalystcloud.io:9999/

s3

https://object-storage.nz-por-1.catalystcloud.io/

volume

https://api.nz-por-1.catalystcloud.io:8776/v1/%projectid%

volumev2

https://api.nz-por-1.catalystcloud.io:8776/v2/%projectid%

volumev3

https://api.nz-por-1.catalystcloud.io:8776/v3/%projectid%

Endpoints for “nz_wlg_2”

Service

Endpoint

alarming

https://api.cloud.catalyst.net.nz:8042

cloudformation

https://api.cloud.catalyst.net.nz:8000/v1/

compute

https://api.cloud.catalyst.net.nz:8774/v2/%projectid%

computev3

https://api.cloud.catalyst.net.nz:8774/v3

container infra

https://api.cloud.catalyst.net.nz:9511/v1

database

https://api.cloud.catalyst.net.nz:8779/v1.0/%projectid%

identity

https://api.cloud.catalyst.net.nz:5000

image

https://api.cloud.catalyst.net.nz:9292

metering

https://api.cloud.catalyst.net.nz:8777

network

https://api.cloud.catalyst.net.nz:9696/

object-store

https://object-storage.nz-wlg-2.catalystcloud.io:443/v1/AUTH_%projectid%

orchestration

https://api.cloud.catalyst.net.nz:8004/v1/%projectid%

ratingv2

https://api.cloud.catalyst.net.nz:9999/

s3

https://object-storage.nz-wlg-2.catalystcloud.io/

volume

https://api.cloud.catalyst.net.nz:8776/v1/%projectid%

volumev2

https://api.cloud.catalyst.net.nz:8776/v2/%projectid%

volumev3

https://api.cloud.catalyst.net.nz:8776/v3/%projectid%

Endpoints for “nz-hlz-1”

Service

Endpoint

alarming

https://api.nz-hlz-1.catalystcloud.io:8042

cloudformation

https://api.nz-hlz-1.catalystcloud.io:8000/v1/

compute

https://api.nz-hlz-1.catalystcloud.io:8774/v2/%projectid%

computev3

https://api.nz-hlz-1.catalystcloud.io:8774/v3

container infra

https://api.nz-hlz-1.catalystcloud.io:9511/v1

database

https://api.nz-hlz-1.catalystcloud.io:8779/v1.0/%projectid%

identity

https://api.nz-hlz-1.catalystcloud.io:5000

image

https://api.nz-hlz-1.catalystcloud.io:9292

metering

https://api.nz-hlz-1.catalystcloud.io:8777

network

https://api.nz-hlz-1.catalystcloud.io:9696/

object-store

https://object-storage.nz-hlz-1.catalystcloud.io:443/v1/AUTH_%projectid%

orchestration

https://api.nz-hlz-1.catalystcloud.io:8004/v1/%projectid%

ratingv2

https://api.nz-hlz-1.catalystcloud.io:9999/

s3

https://object-storage.nz-hlz-1.catalystcloud.io/

volume

https://api.nz-hlz-1.catalystcloud.io:8776/v1/%projectid%

volumev2

https://api.nz-hlz-1.catalystcloud.io:8776/v2/%projectid%

volumev3

https://api.nz-hlz-1.catalystcloud.io:8776/v3/%projectid%