Get started with API v1.1

Make your first authenticated request to the cloudnumbering API v1.1.

Before you start

Create API client credentials and store the client secret in a secrets manager. The portal shows the secret only once.

The API v1.1 base URL is https://api.cloudnumbering.com/v1.1.

Request an access token

1. In Bash, read your client ID and client secret into environment variables without putting the secret in shell history.

   Bash

   read -r -p 'Client ID: ' CLOUDNUMBERING_CLIENT_ID
   read -r -s -p 'Client secret: ' CLOUDNUMBERING_CLIENT_SECRET
   printf '\n'
   export CLOUDNUMBERING_CLIENT_ID CLOUDNUMBERING_CLIENT_SECRET

2. Request an access token.

   Shell

   curl --silent --show-error \
     --request POST \
     --url-query 'grant_type=client_credentials' \
     --url-query "client_id=$CLOUDNUMBERING_CLIENT_ID" \
     --url-query "client_secret=$CLOUDNUMBERING_CLIENT_SECRET" \
     'https://api.cloudnumbering.com/v1.1/oauth/token'

3. Copy the returned access_token, then read it into an environment variable without putting it in shell history.

   Bash

   read -r -s -p 'Access token: ' CLOUDNUMBERING_ACCESS_TOKEN
   printf '\n'
   export CLOUDNUMBERING_ACCESS_TOKEN

Security: The token endpoint accepts credentials as query parameters. Configure clients, proxies, shell history, and monitoring tools to redact query strings.

Make your first request

List the catalogue available to your organisation:

curl --silent --show-error \
  --header "Authorization: Bearer $CLOUDNUMBERING_ACCESS_TOKEN" \
  'https://api.cloudnumbering.com/v1.1/catalogue'

A successful response has success set to true and includes the available catalogue entries in result.entries.

Troubleshooting

The API returns 401 Unauthorized

Request a new access token, then confirm the request header starts with Authorization: Bearer .

The API returns 404 Route not found

Confirm that the method and path use /v1.1/, then check the generated API reference.

Next steps

• Authenticate API v1.1 requests
• Review the authentication endpoint
• Browse the API reference
• Download the API v1.1 OpenAPI document