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.

🚧

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 changed when:

  • User is deleted
  • User is disabled
  • Password change
  • Email address change

Base URLs

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

📘

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'
curl --request GET \
     --url https://abcompany.app.eu.coalescesoftware.io/scheduler/runStatus \\
     --header 'Authorization: Bearer <Access Token>' \
     --header 'accept: application/json'