Resolve labels for stored Git scope qualifiers

GET

/api/integrations/{provider}/{connectorId}/scope-targets/resolve

curl --request GET \
  --url 'https://gateway.example.com/api/integrations/gitlab/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/scope-targets/resolve?ids=example' \
  --header 'Authorization: Bearer <token>'

• Your Gateway instance

Labels for qualifiers relative to the connector, passed as ids=group/123,project/456 (GitLab) or ids=owner/789,repo/1011 (GitHub), up to 100. missing is true when the target no longer exists. A target the caller may not view keeps its raw qualifier as the label. Needs integrations:<provider>:view on the connector or on anything in it.

Authorizations

• bearerAuth

Parameters

Path Parameters

provider

required

string

Allowed values: gitlab github

connectorId

required

string format: uuid

Query Parameters

ids

required

string

>= 1 characters <= 4096 characters

Responses

200

Successful response

Media typeapplication/json

object

items

required

Array<object>

object

qualifier

required

string

label

required

string

missing

required

boolean

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}