GitHub API

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

Required permissions

Your API key must have the Configure integrations permission.

Operations

Retrieve configurations

get

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations' \
  --header 'Authorization: Bearer JWT'

200

400

429

200

{
  "configurations": [
    {
      "alias": "text",
      "appUrl": "text",
      "host": "text",
      "installation": {
        "installationId": 1
      },
      "isDefault": true,
      "type": "text"
    }
  ]
}

Successfully found configurations

Retrieve default configuration

get

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/github/default-configuration' \
  --header 'Authorization: Bearer JWT'

200

400

429

200

{
  "alias": "text",
  "host": "text",
  "isDefault": true,
  "type": "text",
  "appUrl": "text",
  "installation": {
    "installationId": 1
  }
}

Successfully found default configuration

Retrieve a single personal configuration

get

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations/personal/{alias}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

429

200

{
  "alias": "text",
  "host": "text",
  "isDefault": true,
  "type": "text"
}

Successfully found configuration

Retrieve a single app configuration

get

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations/app/{alias}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

429

200

{
  "alias": "text",
  "appUrl": "text",
  "host": "text",
  "installation": {
    "installationId": 1
  },
  "isDefault": true,
  "type": "text"
}

Successfully found configuration

Validate all configurations

post

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations/validate' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

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

Successfully validated all configurations

Add a single app configuration

post

Authorizations

Body

aliasstringrequired

apiHoststringoptional

appUrlstringrequired

applicationIdstringrequired

clientIdstringrequired

clientSecretstringrequired

isDefaultbooleanrequired

privateKeystringrequired

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations/app' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "alias": "text",
    "apiHost": "text",
    "appUrl": "text",
    "applicationId": "text",
    "clientId": "text",
    "clientSecret": "text",
    "isDefault": true,
    "privateKey": "text"
  }'

200

400

403

429

200

{
  "alias": "text",
  "appUrl": "text",
  "host": "text",
  "installation": {
    "installationId": 1
  },
  "isDefault": true,
  "type": "text"
}

Successfully added configuration

Validate a configuration

post

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations/validate/{alias}' \
  --header 'Authorization: Bearer JWT'

200

404

429

200

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

Successfully validated configuration

Add a single personal configuration

post

Authorizations

Body

accessTokenstringrequired

aliasstringrequired

apiHoststringoptional

isDefaultbooleanrequired

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations/personal' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "accessToken": "text",
    "alias": "text",
    "apiHost": "text",
    "isDefault": true
  }'

200

400

403

429

200

{
  "alias": "text",
  "host": "text",
  "isDefault": true,
  "type": "text"
}

Successfully added configuration

Update a single app configuration

put

Authorizations

Path parameters

aliasstringrequired

Body

aliasstringrequired

isDefaultbooleanrequired

Responses

application/json

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations/app/{alias}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "alias": "text",
    "isDefault": true
  }'

200

400

403

404

429

200

{
  "alias": "text",
  "appUrl": "text",
  "host": "text",
  "installation": {
    "installationId": 1
  },
  "isDefault": true,
  "type": "text"
}

Successfully updated configuration

Delete a personal configuration

delete

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations/personal/{alias}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

429

200

No body

Successfully deleted configuration

Update a single personal configuration

put

Authorizations

Path parameters

aliasstringrequired

Body

aliasstringrequired

isDefaultbooleanrequired

Responses

application/json

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations/personal/{alias}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "alias": "text",
    "isDefault": true
  }'

200

400

403

404

429

200

{
  "alias": "text",
  "host": "text",
  "isDefault": true,
  "type": "text"
}

Successfully updated configuration

Delete all configurations

delete

Authorizations

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations' \
  --header 'Authorization: Bearer JWT'

200

400

403

429

200

No body

Successfully deleted all configurations

Delete a single app configuration

delete

Authorizations

Path parameters

aliasstringrequired

Responses

application/json

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/github/configurations/app/{alias}' \
  --header 'Authorization: Bearer JWT'

200

400

403

404

429

200

No body

Successfully deleted configuration