Skip to main content
POST
Resolve

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The GoLinkServiceResolveRequest message.

path
string

The path to resolve, e.g. "jira/PROJ-123", "aws/console", "j"

Response

200 - application/json

Successful response

The GoLinkServiceResolveResponse message.

actionId
string

Set when outcome is ACTION. The action ID to trigger.

chooserOptions
Go Link Chooser Option · object[] | null

Set when outcome is CHOOSER. The chooser options to present to the user.

GoLink is the API representation of a go-link.

outcome
enum<string>

The outcome field.

Available options:
GO_LINK_RESOLVE_OUTCOME_UNSPECIFIED,
GO_LINK_RESOLVE_OUTCOME_REDIRECT,
GO_LINK_RESOLVE_OUTCOME_PREREQUISITE_MISSING,
GO_LINK_RESOLVE_OUTCOME_CHOOSER,
GO_LINK_RESOLVE_OUTCOME_ACTION,
GO_LINK_RESOLVE_OUTCOME_NOT_FOUND,
GO_LINK_RESOLVE_OUTCOME_DISABLED
prerequisite
Go Link Prerequisite · object | null

The GoLinkPrerequisite message.

redirectUrl
string

Set when outcome is REDIRECT. The fully resolved URL to redirect to.

suggestions
Go Link View · object[] | null

Set when outcome is NOT_FOUND. Suggested GoLinks that might match the path.