> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/api/api-quickstart.md).

# API Quickstart

## ![](https://2066036200-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdz9Cihd3zGR3GRMtHbln%2Fuploads%2FzF6cQYa8rI5A4rXQeQC1%2FSummary2-Small-Icon.svg?alt=media\&token=b76f02b3-0c59-41c6-8cb7-9c9a6936e554) Overview

This quickstart provides the essential information you need to start working with the Flosum Cloud Apps API. It is designed to help you get oriented quickly so you can begin issuing requests with confidence.

### Available APIs

Currently available Flosum Cloud Apps public APIs:

<table><thead><tr><th width="160">API</th><th>Description</th></tr></thead><tbody><tr><td><a href="/api/devops-api/commits.md">DevOps</a></td><td>Create, commit, merge, and deploy your branches through DevOps.</td></tr><tr><td><a href="/api/backup-and-archive-api/backups-and-archives.md">Backup &#x26; Archive</a></td><td>Create, schedule, run, and manage your backups and archives.</td></tr><tr><td><a href="/api/global-settings-api/oauth.md">Global Settings</a></td><td>Authenticate the connection to your Flosum Cloud Apps tenant.</td></tr></tbody></table>

#### Base URL

The table below lists the base URL for each API. Because Flosum tenants are regionally hosted, use the base URL for the region where your tenant is hosted.

<table><thead><tr><th width="160.3333740234375">API</th><th>United States</th><th>Germany</th><th>Japan</th><th>Australia</th></tr></thead><tbody><tr><td>DevOps</td><td>devops-us.flosum.app</td><td>devops-de.flosum.app</td><td>devops-jp.flosum.app</td><td>devops-au.flosum.app</td></tr><tr><td>Backup &#x26; Archive</td><td>backup-us.flosum.app</td><td>backup-de.flosum.app</td><td>backup-jp.flosum.app</td><td>backup-au.flosum.app</td></tr><tr><td>Global Settings</td><td>global-us.flosum.app</td><td>global-de.flosum.app</td><td>global-jp.flosum.app</td><td>global-au.flosum.app</td></tr></tbody></table>

{% hint style="warning" %}

### Connections vs Organizations

In the Flosum Cloud Apps API, the Salesforce orgs connected to your tenant are called **Connections**, whereas the Flosum Cloud Apps UI refers to them as **Organizations**. Both terms describe the same resource, so an Organization shown in the UI corresponds directly to a Connection returned by the API. Keep this mapping in mind when cross-referencing UI actions with API requests or responses.
{% endhint %}

## Authentication

The Flosum Cloud Apps APIs support OAuth 2.0 authentication through the Global Settings API. Below are the basic steps required to authenticate the connection. This process assumes you are already familiar with OAuth 2.0 authentication using the `authorization_code` flow.

{% stepper %}
{% step %}

### Create Connected App

To authenticate with your Flosum Cloud Apps tenant, you must have a Connected App in Global Settings. This Connected App provides the Client ID and Client Secret values used in authentication. To learn how to create a Connected App to connect an API, see the following article.

* [Creating a Connected App for API Access](/global-settings/security/connected-apps/creating-a-connected-app-for-api-access.md)
  {% endstep %}

{% step %}

### Get Authorization Code

**Endpoint**: [OAuth](/api/global-settings-api/oauth.md#get-api-v1-oauth-authorize)

Open the authorization URL in a browser, sign in to Global Settings, and approve the connected app. After the browser redirects to your callback URL, copy the `code` query parameter from that URL.
{% endstep %}

{% step %}

### Exchange the Code for a Token

**Endpoint**: [OAuth](/api/global-settings-api/oauth.md#post-api-v1-oauth-token)

Send the request using the body keys below.

<table><thead><tr><th width="199.6666259765625">Key</th><th>Value</th></tr></thead><tbody><tr><td><code>grant_type</code></td><td><code>authorization_code</code></td></tr><tr><td><code>code</code></td><td>The <strong>Authorization Code</strong> from the previous step.</td></tr><tr><td><code>redirect_uri</code></td><td>The same redirect URI used in the previous step.</td></tr><tr><td><code>client_id</code></td><td>Your <code>Client Id</code></td></tr><tr><td><code>client_secret</code></td><td>Your <code>Client Secret</code></td></tr></tbody></table>

A successful `200` response returns an `access_token` and a `refresh_token`. Pass the `access_token` in the `Authorization: Bearer` header on subsequent API calls, and store the `refresh_token` so you can obtain a new access token when the current one expires.
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.flosum.com/api/api-quickstart.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.