Last updated 1 month ago
Use these operations to interact with the in Cortex.
Your API key must have the Configure integrations permission.
Configure integrations
GET /api/v1/github/configurations HTTP/1.1 Host: api.getcortexapp.com Authorization: Bearer JWT Accept: */*
Successfully found configurations
{ "configurations": [ { "alias": "text", "appUrl": "text", "host": "text", "installation": { "installationId": 1 }, "isDefault": true, "type": "text" } ] }
GET /api/v1/github/default-configuration HTTP/1.1 Host: api.getcortexapp.com Authorization: Bearer JWT Accept: */*
Successfully found default configuration
{ "alias": "text", "host": "text", "isDefault": true, "type": "text", "appUrl": "text", "installation": { "installationId": 1 } }
GET /api/v1/github/configurations/personal/{alias} HTTP/1.1 Host: api.getcortexapp.com Authorization: Bearer JWT Accept: */*
Successfully found configuration
{ "alias": "text", "host": "text", "isDefault": true, "type": "text" }
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" }
POST /api/v1/github/configurations/validate HTTP/1.1 Host: api.getcortexapp.com Authorization: Bearer JWT Accept: */*
Successfully validated all configurations
{ "configurations": [ { "alias": "text", "isValid": true, "message": "text" } ] }
POST /api/v1/github/configurations/validate/{alias} HTTP/1.1 Host: api.getcortexapp.com Authorization: Bearer JWT Accept: */*
Successfully validated configuration
{ "alias": "text", "isValid": true, "message": "text" }
DELETE /api/v1/github/configurations/personal/{alias} HTTP/1.1 Host: api.getcortexapp.com Authorization: Bearer JWT Accept: */*
Successfully deleted configuration
No content
DELETE /api/v1/github/configurations HTTP/1.1 Host: api.getcortexapp.com Authorization: Bearer JWT Accept: */*
Successfully deleted all configurations
DELETE /api/v1/github/configurations/app/{alias} HTTP/1.1 Host: api.getcortexapp.com Authorization: Bearer JWT Accept: */*
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" }
Successfully added configuration
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 }
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 }
Successfully updated configuration
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 }