GitLab API

Use these operations to interact with the GitLab integration in Cortex.

Required permissions

Your API key must have the Configure integrations permission.

Operations

Retrieve configurations

get

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Responses

200

Successfully found configurations

application/json

400

Bad Request

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/gitlab/configurations

HTTPcURLJavaScriptPython

GET /api/v1/gitlab/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "configurations": [
    {
      "alias": "text",
      "groupNames": [
        "text"
      ],
      "hidePersonalProjects": true,
      "host": "text",
      "isDefault": true,
      "lastFour": "text"
    }
  ]
}

Retrieve default configuration

get

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Responses

200

Successfully found default configuration

application/json

400

Bad Request

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/gitlab/default-configuration

HTTPcURLJavaScriptPython

GET /api/v1/gitlab/default-configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "alias": "text",
  "groupNames": [
    "text"
  ],
  "hidePersonalProjects": true,
  "host": "text",
  "isDefault": true,
  "lastFour": "text"
}

Retrieve a configuration

get

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

aliasstringRequired

Responses

200

Successfully found configuration

application/json

400

Bad Request

application/json

404

Configuration not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/gitlab/configuration/{alias}

HTTPcURLJavaScriptPython

GET /api/v1/gitlab/configuration/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "alias": "text",
  "groupNames": [
    "text"
  ],
  "hidePersonalProjects": true,
  "host": "text",
  "isDefault": true,
  "lastFour": "text"
}

Add a single configuration

post

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Body

application/json

aliasstringRequired

groupNamesstring[]Required

hidePersonalProjectsbooleanRequired

hoststringOptional

isDefaultbooleanRequired

personalAccessTokenstringRequired

Responses

200

Successfully added configuration

application/json

400

Bad Request

application/json

403

Forbidden

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/gitlab/configuration

HTTPcURLJavaScriptPython

POST /api/v1/gitlab/configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "alias": "text",
  "groupNames": [
    "text"
  ],
  "hidePersonalProjects": true,
  "host": "text",
  "isDefault": true,
  "personalAccessToken": "text"
}

{
  "configurations": [
    {
      "alias": "text",
      "groupNames": [
        "text"
      ],
      "hidePersonalProjects": true,
      "host": "text",
      "isDefault": true,
      "lastFour": "text"
    }
  ]
}

Validate all configurations

post

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Responses

200

Successfully validated all configurations

application/json

404

Configuration not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/gitlab/configuration/validate

HTTPcURLJavaScriptPython

POST /api/v1/gitlab/configuration/validate HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "configurations": [
    {
      "alias": "text",
      "isValid": true,
      "message": "text"
    }
  ]
}

Validate a configuration

post

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

aliasstringRequired

Responses

200

Successfully validated configuration

application/json

404

Configuration not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/gitlab/configuration/validate/{alias}

HTTPcURLJavaScriptPython

POST /api/v1/gitlab/configuration/validate/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "alias": "text",
  "isValid": true,
  "message": "text"
}

Update a configuration

put

WARNING: Updating aliases for configurations or changing the default configuration could cause entity YAMLs that use this integration to break.

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

aliasstringRequired

Body

application/json

aliasstringRequired

groupNamesstring[]Required

hidePersonalProjectsbooleanRequired

hoststringOptional

isDefaultbooleanRequired

Responses

200

Successfully updated configuration

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Configuration not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

put

/api/v1/gitlab/configuration/{alias}

HTTPcURLJavaScriptPython

PUT /api/v1/gitlab/configuration/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "alias": "text",
  "groupNames": [
    "text"
  ],
  "hidePersonalProjects": true,
  "host": "text",
  "isDefault": true
}

{
  "configurations": [
    {
      "alias": "text",
      "groupNames": [
        "text"
      ],
      "hidePersonalProjects": true,
      "host": "text",
      "isDefault": true,
      "lastFour": "text"
    }
  ]
}

Add multiple configurations

post

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Body

application/json

Responses

200

Successfully added configurations

application/json

403

Forbidden

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/gitlab/configurations

HTTPcURLJavaScriptPython

POST /api/v1/gitlab/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "configurations": [
    {
      "alias": "text",
      "groupNames": [
        "text"
      ],
      "hidePersonalProjects": true,
      "host": "text",
      "isDefault": true,
      "personalAccessToken": "text"
    }
  ]
}

{
  "configurations": [
    {
      "alias": "text",
      "groupNames": [
        "text"
      ],
      "hidePersonalProjects": true,
      "host": "text",
      "isDefault": true,
      "lastFour": "text"
    }
  ],
  "skippedConfigurations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Delete all configurations

delete

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Responses

200

Successfully deleted all configurations

400

Bad Request

application/json

403

Forbidden

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/gitlab/configurations

HTTPcURLJavaScriptPython

DELETE /api/v1/gitlab/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Delete a configuration

delete

Authorizations

bearerAuth

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

aliasstringRequired

Responses

200

Successfully deleted configuration

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Configuration not found

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/gitlab/configuration/{alias}

HTTPcURLJavaScriptPython

DELETE /api/v1/gitlab/configuration/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "configurations": [
    {
      "alias": "text",
      "groupNames": [
        "text"
      ],
      "hidePersonalProjects": true,
      "host": "text",
      "isDefault": true,
      "lastFour": "text"
    }
  ]
}