Skip to main content
POST
Connect a Jira site with an API token

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json

Request body to connect a Jira site using an API token.

An alternative to the OAuth connect flow, for sites that prefer a long-lived API token over an OAuth grant.

email
string
required
write-only

Email address of the Atlassian account the API token belongs to. Stored with the token as part of the credential, so like the token it is never returned by a read.

api_token
string
required
write-only

Atlassian API token. Never returned by a read.

site_url
string
required

URL of the Atlassian Cloud site to connect, e.g. https://yourcompany.atlassian.net.

Response

Successful Response

A connection to an external ticketing system.

id
string
required
read-only

Opaque identifier for this integration. Set when the site is connected and immutable afterward.

etag
string
required
read-only

Opaque strong ETag for this integration's configuration. Matches the ETag response header, and is what If-Match requires on a write. It changes whenever a configurable field on the integration changes.

provider
string
required
read-only

The external ticketing system this integration connects to.

Allowed value: "jira"
status
enum<string>
required
read-only

Current status of SELECT's connection to this integration.

Available options:
unknown,
pending,
failing,
connected
auth_method
enum<string>
required
read-only

How SELECT authenticates to this integration.

Available options:
oauth,
token
credentials_configured
boolean
required
read-only

Whether SELECT holds credentials for this integration. The credentials themselves are never returned.

create_time
string
required
read-only

When the integration was connected, as an RFC 3339 UTC timestamp.

update_time
string
required
read-only

When the integration was last changed, as an RFC 3339 UTC timestamp.

display_name
string | null

Display name for the integration, as shown throughout SELECT.

site_url
string | null

URL of the connected site.

external_id
string | null

Identifier the provider assigns to the connected site. For Jira, the Atlassian cloud id of the site, which stays the same if the site is renamed. Null when the provider has not supplied one.