Skip to main content
POST
Plan a GitHub credential replacement

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

credential_id
string<uuid>
required

Body

application/json
target_credential_id
string<uuid>
required

The GitHub App credential the usages would move to.

usage_resource_ids
string<uuid>[] | null

Limit the plan to these usages; omitted or null plans every usage of the source credential.

Response

Plan built

source_credential
object
required

The credential: id, name, provider, credential_scope (organisation or personal), state, available, account_login, account_type, installation_id, app_backed, last_synced_at and syncing.

target_credential
object
required

The credential: id, name, provider, credential_scope (organisation or personal), state, available, account_login, account_type, installation_id, app_backed, last_synced_at and syncing.

ambiguous_source_credential_name
boolean
required
target_last_synced_at
string | null
required
target_syncing
boolean
required
sync_required
boolean
required

True when the target credential's repositories must be synced before any usage can be replaced.

eligible_usages
object[]
required
blocked_usages
object[]
required