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
Successfully found configurations
Bad Request
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/github/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"configurations": [
{
"alias": "text",
"appUrl": "text",
"host": "text",
"installation": {
"installationId": 1
},
"isDefault": true,
"type": "text"
}
]
}Successfully found default configuration
Bad Request
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/github/default-configuration HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"alias": "text",
"host": "text",
"isDefault": true,
"type": "text",
"appUrl": "text",
"installation": {
"installationId": 1
}
}Successfully found configuration
Bad Request
Forbidden
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/github/configurations/personal/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"alias": "text",
"host": "text",
"isDefault": true,
"type": "text"
}Successfully found configuration
Bad Request
Forbidden
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/github/configurations/app/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"alias": "text",
"appUrl": "text",
"host": "text",
"installation": {
"installationId": 1
},
"isDefault": true,
"type": "text"
}Successfully validated all configurations
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/github/configurations/validate HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"configurations": [
{
"alias": "text",
"isValid": true,
"message": "text"
}
]
}Successfully added configuration
Bad Request
Forbidden
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/github/configurations/app HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 149
{
"alias": "text",
"apiHost": "text",
"appUrl": "text",
"applicationId": "text",
"clientId": "text",
"clientSecret": "text",
"isDefault": true,
"privateKey": "text"
}{
"alias": "text",
"appUrl": "text",
"host": "text",
"installation": {
"installationId": 1
},
"isDefault": true,
"type": "text"
}Successfully validated configuration
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/github/configurations/validate/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
"alias": "text",
"isValid": true,
"message": "text"
}Successfully added configuration
Bad Request
Forbidden
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/github/configurations/personal HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"accessToken": "text",
"alias": "text",
"apiHost": "text",
"isDefault": true
}{
"alias": "text",
"host": "text",
"isDefault": true,
"type": "text"
}Successfully updated configuration
Bad Request
Forbidden
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
PUT /api/v1/github/configurations/app/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"alias": "text",
"isDefault": true
}{
"alias": "text",
"appUrl": "text",
"host": "text",
"installation": {
"installationId": 1
},
"isDefault": true,
"type": "text"
}Successfully deleted configuration
No content
Bad Request
Forbidden
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/github/configurations/personal/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Successfully updated configuration
Bad Request
Forbidden
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
PUT /api/v1/github/configurations/personal/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 33
{
"alias": "text",
"isDefault": true
}{
"alias": "text",
"host": "text",
"isDefault": true,
"type": "text"
}Successfully deleted all configurations
No content
Bad Request
Forbidden
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/github/configurations HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Successfully deleted configuration
No content
Bad Request
Forbidden
Configuration not found
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/github/configurations/app/{alias} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
No content
Last updated
Was this helpful?