Skip to main content

Getting Your Token

Coalesce uses Bearer Authentication to make API requests. Bearer authentication is an HTTP authentication method that uses bearer tokens (Access Token). The token is encrypted, usually by the server. When making a request to Coalesce, it looks like this:

'Authorization: Bearer <Access Token>'

Getting Your Access Token​

Coalesce requires an access token to make API requests. Go to the Deploy tab and click Generate Access Token.

Generate Coalesce access token
Access Token Regeneration

Access tokens are regenerated after each login. Previously issued tokens remain valid. Tokens never expire across all environments and projects. Tokens are revoked when:

  • User is deleted
  • User is disabled
  • Password change
  • Email address change
  • SSO users will need a new token for each new environment created.
  • Turning Multi-factor Authentication on and off.

Base URLs​

Coalesce offers several deployments, and you'll need to make your API calls using the endpoint that corresponds to your Coalesce deployment.

GeographyRegionBase URL
Australiaaustralia-southeast1https://app.australia-southeast1.gcp.coalescesoftware.io/
Canadanorthamerica-northeast1https://app.northamerica-northeast1.gcp.coalescesoftware.io/
Europeeu-west-2https://app.eu-west-2.aws.coalescesoftware.io
Europeeurope-west-3https://app.eu.coalescesoftware.io/
Europeeurope-west-1https://app.europe-west1.gcp.coalescesoftware.io/
UScentralushttps://app.centralus.azure.coalescesoftware.io/
USeastus2https://app.eastus2.azure.coalescesoftware.io
USwestus2https://app.westus2.azure.coalescesoftware.io
USsouthcentralhttps://app.southcentralus.azure.coalescesoftware.io
USus-east-1https://app.us-east-1.aws.coalescesoftware.io
USus-west-2https://app.us-west-2.aws.coalescesoftware.io
USus-central1https://app.coalescesoftware.io
US east with PrivateLinkus-east-1https://app.us-east-1.aws.privatelink.coalescesoftware.io
US west with PrivateLinkus-west-2https://app.us-west-2.aws.privatelink.coalescesoftware.io
SSO Authentication

If you use SSO for Authentication, you can prefix the URL to the endpoint with your subdomain. https://mySubdomain.<app_domain> For example if your company name is ABCompany and you are using Europe primary you can use https://abcompany.app.eu.coalescesoftware.io.

API Request Example​

    curl --request GET \
    --url https://app.coalescesoftware.io/scheduler/runStatus \
    --header 'Authorization: Bearer <Access Token>' \
    --header 'accept: application/json'