Using the Structure Cloud API

Base Paths for API Access

Use one of the following paths, depending on where your Structure Cloud data is located:

• For clients in Europe: https://api.prod-eu-central-1.structure.app/api/v1

• For clients in the Americas: https://api.structure.app/api/v1

You will receive an authorization error if you use an incorrect base path.

Authentication

Using the REST API as an individual user

You can use the Structure Cloud API to interact with any data you have access to. To do so, you will need to generate a personal access token (PAT):

1. Go to your Structure personal settings page:
   https://your-jira-instance-name.atlassian.net/plugins/servlet/ac/com.almworks.jira.structure/personal-structure-settings

2. Select Create token.

3. Give your new token a name and set the amount of time before it expires, then select Create. Make sure you copy the key and save it to a secure location for later use.

4. Once you have your token, you need to use it inside the Authorization HTTP header. For example:
   curl -v -H "Authorization: Bearer $your-API-token" "https://api.structure.app/v1/structure?..."