Cortex API (v1)
Download OpenAPI specification:Download
Bulk Upload Custom Data
Authorizations:
bearerAuth
query Parameters
force | boolean |
Request Body schema: application/json
object | |||||||||||
|
Responses
Request samples
- Payload
Content type
application/json
{- "values": {
- "property1": [
- {
- "key": "string",
- "value": { },
- "description": "string"
}
], - "property2": [
- {
- "key": "string",
- "value": { },
- "description": "string"
}
]
}
}
Response samples
- 200
Content type
application/json
{- "values": [
- {
- "id": 0,
- "key": "string",
- "value": { },
- "source": "YAML",
- "dateUpdated": "2019-08-24T14:15:22Z",
- "description": "string"
}
]
}
Add custom data
Authorizations:
bearerAuth
path Parameters
tag required | string |
query Parameters
force | boolean |
Request Body schema: application/json
key | string |
value | object (CustomDataType) |
description | string |
Responses
Request samples
- Payload
Content type
application/json
{- "key": "string",
- "value": { },
- "description": "string"
}
Response samples
- 200
- 400
- 404
Content type
application/json
{- "id": 0,
- "key": "string",
- "value": { },
- "source": "YAML",
- "dateUpdated": "2019-08-24T14:15:22Z",
- "description": "string"
}
Delete custom data
Authorizations:
bearerAuth
path Parameters
tag required | string |
query Parameters
key required | string |
force | boolean |
Responses
Response samples
- 404
Content type
application/json
{- "type": "INTEGRATION_MISSING",
- "message": "string",
- "httpStatus": 0,
- "details": "string",
- "gatewayHttpStatus": 0,
- "requestId": "string"
}
Get the value of custom data stored under a key
Authorizations:
bearerAuth
path Parameters
tag required | string |
key required | string |
Responses
Response samples
- 200
- 404
Content type
application/json
{- "id": 0,
- "key": "string",
- "value": { },
- "source": "YAML",
- "dateUpdated": "2019-08-24T14:15:22Z",
- "description": "string"
}
Response samples
- 200
- 404
Content type
application/json
[- {
- "id": 0,
- "title": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "type": "DEPLOY",
- "sha": "string",
- "deployerName": "string",
- "deployerEmail": "string",
- "environment": "string",
- "customData": {
- "property1": "string",
- "property2": "string"
}
}
]
Add deployment
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
title | string |
timestamp | string <date-time> |
type | string Enum: "DEPLOY" "SCALE" "ROLLBACK" "RESTART" |
sha | string |
object (Deployer) | |
environment | string |
object |
Responses
Request samples
- Payload
Content type
application/json
{- "title": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "type": "DEPLOY",
- "sha": "string",
- "deployer": {
- "name": "string",
- "email": "string"
}, - "environment": "string",
- "customData": {
- "property1": "string",
- "property2": "string"
}
}
Response samples
- 200
- 404
Content type
application/json
{- "id": 0,
- "title": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "type": "DEPLOY",
- "sha": "string",
- "deployerName": "string",
- "deployerEmail": "string",
- "environment": "string",
- "customData": {
- "property1": "string",
- "property2": "string"
}
}
Delete deployments with filters
Authorizations:
bearerAuth
query Parameters
environment | string |
sha | string |
type | string Enum: "DEPLOY" "SCALE" "ROLLBACK" "RESTART" |
Responses
Response samples
- 400
Content type
application/json
{- "type": "INTEGRATION_MISSING",
- "message": "string",
- "httpStatus": 0,
- "details": "string",
- "gatewayHttpStatus": 0,
- "requestId": "string"
}
Upload requirements.txt packages
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
string
Responses
Request samples
- Payload
Content type
application/json
"string"
Response samples
- 200
- 404
Content type
application/json
[- {
- "id": 0,
- "packageType": "NODE",
- "name": "string",
- "version": "string",
- "dateCreated": "2019-08-24T14:15:22Z"
}
]
Upload pipfile.lock packages
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
string
Responses
Request samples
- Payload
Content type
application/json
"string"
Response samples
- 200
- 404
Content type
application/json
[- {
- "id": 0,
- "packageType": "NODE",
- "name": "string",
- "version": "string",
- "dateCreated": "2019-08-24T14:15:22Z"
}
]
Upload Java package version
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
name | string |
version | string |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "version": "string"
}
Response samples
- 200
- 404
Content type
application/json
[- {
- "id": 0,
- "packageType": "NODE",
- "name": "string",
- "version": "string",
- "dateCreated": "2019-08-24T14:15:22Z"
}
]
Delete Java package version
Authorizations:
bearerAuth
path Parameters
tag required | string |
query Parameters
name required | string |
Responses
Response samples
- 404
Content type
application/json
{- "type": "INTEGRATION_MISSING",
- "message": "string",
- "httpStatus": 0,
- "details": "string",
- "gatewayHttpStatus": 0,
- "requestId": "string"
}
Bulk upload Nuget package versions from .csproj
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
string
Responses
Request samples
- Payload
Content type
application/json
"string"
Response samples
- 200
- 404
Content type
application/json
[- {
- "id": 0,
- "packageType": "NODE",
- "name": "string",
- "version": "string",
- "dateCreated": "2019-08-24T14:15:22Z"
}
]
Bulk upload Nuget package versions from packages.lock.json
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
string
Responses
Request samples
- Payload
Content type
application/json
"string"
Response samples
- 200
- 404
Content type
application/json
[- {
- "id": 0,
- "packageType": "NODE",
- "name": "string",
- "version": "string",
- "dateCreated": "2019-08-24T14:15:22Z"
}
]
Upload package.lock packages
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
string
Responses
Request samples
- Payload
Content type
application/json
"string"
Response samples
- 200
- 404
Content type
application/json
[- {
- "id": 0,
- "packageType": "NODE",
- "name": "string",
- "version": "string",
- "dateCreated": "2019-08-24T14:15:22Z"
}
]
Upload yarn.lock packages
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
string
Responses
Request samples
- Payload
Content type
application/json
"string"
Response samples
- 200
- 404
Content type
application/json
[- {
- "id": 0,
- "packageType": "NODE",
- "name": "string",
- "version": "string",
- "dateCreated": "2019-08-24T14:15:22Z"
}
]
Upload go.sum packages
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
string
Responses
Request samples
- Payload
Content type
application/json
"string"
Response samples
- 200
- 404
Content type
application/json
[- {
- "id": 0,
- "packageType": "NODE",
- "name": "string",
- "version": "string",
- "dateCreated": "2019-08-24T14:15:22Z"
}
]
Update Scorecard Rules
Authorizations:
bearerAuth
path Parameters
id required | integer <int64> |
Request Body schema: application/json
Array of objects (PublicScorecardRule) | |||||||||||
Array
|
Responses
Request samples
- Payload
Content type
application/json
{- "rules": [
- {
- "expression": "string",
- "weight": 0,
- "description": "string",
- "title": "string",
- "failureMessage": "string"
}
]
}
Response samples
- 200
- 400
- 404
Content type
application/json
{- "rules": [
- {
- "expression": "string",
- "weight": 0,
- "description": "string",
- "title": "string",
- "failureMessage": "string"
}
]
}
Response samples
- 200
- 404
Content type
application/json
{- "scorecardId": 0,
- "scorecardName": "string",
- "scorePercentage": 0,
- "score": 0,
- "totalPossibleScore": 0,
- "ladderLevels": [
- {
- "level": {
- "name": "string",
- "number": 0
}
}
]
}
Response samples
- 200
- 404
Content type
application/json
[- {
- "scorecardId": 0,
- "serviceScores": [
- {
- "service": {
- "id": 0,
- "name": "string",
- "tag": "string",
- "groups": [
- "string"
], - "owners": {
- "groups": [
- "string"
], - "individuals": [
- {
- "email": "string",
- "description": "string"
}
]
}
}, - "score": {
- "summary": {
- "score": 0,
- "percentage": 0,
- "totalPossibleScore": 0
}, - "ladderLevels": [
- {
- "level": {
- "name": "string",
- "number": 0
}
}
], - "rules": [
- {
- "expression": "string",
- "score": 0,
- "error": "string"
}
]
}
}
]
}
]
Create a scorecard using a YAML descriptor
Authorizations:
bearerAuth
Request Body schema: application/yaml
Schema not providedResponses
Response samples
- 200
- 400
Content type
application/json
{- "scorecard": {
- "name": "string",
- "tag": "string",
- "description": "string",
- "isDraft": true,
- "rules": [
- {
- "expression": "string",
- "weight": 0,
- "description": "string",
- "title": "string",
- "failureMessage": "string"
}
], - "levels": [
- {
- "level": {
- "name": "string",
- "number": 0
}
}
]
}
}
Bulk upload Group memberships
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
Array of objects (PublicGroupMembership) | |||
Array
|
Responses
Request samples
- Payload
Content type
application/json
{- "groups": [
- {
- "tag": "string"
}
]
}
Response samples
- 200
- 400
- 404
Content type
application/json
{- "groups": [
- {
- "tag": "string"
}
]
}
Delete Group memberships
Authorizations:
bearerAuth
path Parameters
tag required | string |
Request Body schema: application/json
Array of objects (PublicGroupMembership) | |||
Array
|
Responses
Request samples
- Payload
Content type
application/json
{- "groups": [
- {
- "tag": "string"
}
]
}
Response samples
- 400
- 404
Content type
application/json
{- "type": "INTEGRATION_MISSING",
- "message": "string",
- "httpStatus": 0,
- "details": "string",
- "gatewayHttpStatus": 0,
- "requestId": "string"
}
Bulk replace Group Relationships
Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects (PublicGroupRelationship) | |||||
Array
|
Responses
Request samples
- Payload
Content type
application/json
{- "relationships": [
- {
- "parent": "string",
- "child": "string"
}
]
}
Response samples
- 200
- 400
Content type
application/json
{- "relationships": [
- {
- "parent": "string",
- "child": "string"
}
]
}
Retrieve data for a single entity
Authorizations:
bearerAuth
path Parameters
tag required | string |
Responses
Response samples
- 200
Content type
application/json
{- "name": "string",
- "tag": "string",
- "description": "string",
- "groups": [
- "string"
], - "owners": {
- "groups": [
- "string"
], - "slackChannels": [
- "string"
], - "emails": [
- "string"
]
}, - "ownership": {
- "groups": [
- {
- "groupName": "string",
- "description": "string",
- "provider": "ACTIVE_DIRECTORY"
}
], - "slackChannels": [
- {
- "channel": "string",
- "description": "string",
- "notificationsEnabled": true
}
], - "emails": [
- {
- "email": "string",
- "description": "string"
}
]
}, - "metadata": [
- {
- "key": "string",
- "value": { }
}
], - "links": [
- {
- "id": 0,
- "name": "string",
- "type": "string",
- "url": "string",
- "description": "string"
}
]
}
Bulk Upload Dependencies
Authorizations:
bearerAuth
Request Body schema: application/json
object | |||||||||||||||
|
Responses
Request samples
- Payload
Content type
application/json
{- "values": {
- "property1": [
- {
- "tag": "string",
- "method": "string",
- "path": "string",
- "description": "string",
- "metadata": { }
}
], - "property2": [
- {
- "tag": "string",
- "method": "string",
- "path": "string",
- "description": "string",
- "metadata": { }
}
]
}
}
Response samples
- 200
- 400
- 404
Content type
application/json
{- "values": {
- "property1": [
- {
- "tag": "string",
- "method": "GET",
- "path": "string",
- "description": "string",
- "metadata": { }
}
], - "property2": [
- {
- "tag": "string",
- "method": "GET",
- "path": "string",
- "description": "string",
- "metadata": { }
}
]
}
}
Bulk Delete Dependencies
Authorizations:
bearerAuth
Request Body schema: application/json
object | |||||||||||||||
|
Responses
Request samples
- Payload
Content type
application/json
{- "values": {
- "property1": [
- {
- "tag": "string",
- "method": "string",
- "path": "string",
- "description": "string",
- "metadata": { }
}
], - "property2": [
- {
- "tag": "string",
- "method": "string",
- "path": "string",
- "description": "string",
- "metadata": { }
}
]
}
}
Response samples
- 400
- 404
Content type
application/json
{- "type": "INTEGRATION_MISSING",
- "message": "string",
- "httpStatus": 0,
- "details": "string",
- "gatewayHttpStatus": 0,
- "requestId": "string"
}
Get Dependencies
Authorizations:
bearerAuth
path Parameters
callerTag required | string |
calleeTag required | string |
query Parameters
method | string |
path | string |
Responses
Response samples
- 200
- 400
- 404
Content type
application/json
{- "callerTag": "string",
- "calleeTag": "string",
- "method": "GET",
- "path": "string",
- "description": "string",
- "metadata": { }
}
Update Dependencies
Authorizations:
bearerAuth
path Parameters
callerTag required | string |
calleeTag required | string |
query Parameters
method | string |
path | string |
Request Body schema: application/json
description required | string |
metadata required | object (JsonNode) |
Responses
Request samples
- Payload
Content type
application/json
{- "description": "string",
- "metadata": { }
}
Response samples
- 200
- 400
- 404
Content type
application/json
{- "callerTag": "string",
- "calleeTag": "string",
- "method": "GET",
- "path": "string",
- "description": "string",
- "metadata": { }
}
Create Dependencies
Authorizations:
bearerAuth
path Parameters
callerTag required | string |
calleeTag required | string |
query Parameters
method | string |
path | string |
Request Body schema: application/json
description | string |
metadata | object (JsonNode) |
Responses
Request samples
- Payload
Content type
application/json
{- "description": "string",
- "metadata": { }
}
Response samples
- 201
- 400
- 404
Content type
application/json
{- "callerTag": "string",
- "calleeTag": "string",
- "method": "GET",
- "path": "string",
- "description": "string",
- "metadata": { }
}
Delete Dependency
Authorizations:
bearerAuth
path Parameters
callerTag required | string |
calleeTag required | string |
query Parameters
method | string |
path | string |
Responses
Response samples
- 400
- 404
Content type
application/json
{- "type": "INTEGRATION_MISSING",
- "message": "string",
- "httpStatus": 0,
- "details": "string",
- "gatewayHttpStatus": 0,
- "requestId": "string"
}
Response samples
- 200
- 404
Content type
application/json
{- "type": "cortex",
- "teamTag": "string",
- "metadata": {
- "name": "string",
- "description": "string",
- "summary": "string"
}, - "links": [
- {
- "name": "string",
- "type": "string",
- "url": "string",
- "description": "string"
}
], - "slackChannels": [
- {
- "name": "string",
- "notificationsEnabled": true
}
], - "additionalMembers": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
], - "idpGroup": {
- "group": "string",
- "provider": "string"
}, - "cortexTeam": {
- "members": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
]
}
}
Update an existing team's metadata
Authorizations:
bearerAuth
path Parameters
teamTag required | string |
Request Body schema: application/json
Responses
Request samples
- Payload
Content type
application/json
Example
Update an existing idp team
{- "type": "idp",
- "metadata": {
- "name": "Updated name",
- "description": "Updated description",
- "summary": "Updated summary"
}, - "links": [
], - "slackChannels": [
- {
- "name": "engineering",
- "notificationsEnabled": true
}
], - "additionalMembers": [
- {
- "name": "Aditya Manager",
- "email": "aditya-m@cortex.io"
}
]
}
Response samples
- 200
- 400
- 404
Content type
application/json
Example
Team backed by an identity provider
{- "type": "idp",
- "teamTag": "cortexapps-engineering",
- "metadata": {
- "name": "Cortex Engineering Team",
- "description": "Cortex Engineers",
- "summary": "This main engineering team that reviews all the code"
}, - "links": [
], - "slackChannels": [
- {
- "name": "engineering",
- "notificationsEnabled": true
}
], - "additionalMembers": [
- {
- "name": "Aditya Manager",
- "email": "aditya-m@cortex.io"
}
], - "idpGroup": {
- "group": "cortexapps/engineering",
- "provider": "GIT"
}
}
Update an existing cortex team's members
Authorizations:
bearerAuth
query Parameters
teamTag required | string |
Request Body schema: application/json
Responses
Request samples
- Payload
Content type
application/json
No sample
Response samples
- 200
- 400
- 404
Content type
application/json
{- "type": "cortex",
- "teamTag": "string",
- "metadata": {
- "name": "string",
- "description": "string",
- "summary": "string"
}, - "links": [
- {
- "name": "string",
- "type": "string",
- "url": "string",
- "description": "string"
}
], - "slackChannels": [
- {
- "name": "string",
- "notificationsEnabled": true
}
], - "additionalMembers": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
], - "idpGroup": {
- "group": "string",
- "provider": "string"
}, - "cortexTeam": {
- "members": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
]
}
}
Response samples
- 200
Content type
application/json
{- "teams": [
- {
- "type": "cortex",
- "teamTag": "string",
- "metadata": {
- "name": "string",
- "description": "string",
- "summary": "string"
}, - "links": [
- {
- "name": "string",
- "type": "string",
- "url": "string",
- "description": "string"
}
], - "slackChannels": [
- {
- "name": "string",
- "notificationsEnabled": true
}
], - "additionalMembers": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
], - "idpGroup": {
- "group": "string",
- "provider": "string"
}, - "cortexTeam": {
- "members": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
]
}
}
]
}
Request samples
- Payload
Content type
application/json
Example
Team backed by an identity provider
{- "type": "idp",
- "teamTag": "cortexapps-engineering",
- "metadata": {
- "name": "Cortex Engineering Team",
- "description": "Cortex Engineers",
- "summary": "This main engineering team that reviews all the code"
}, - "links": [
], - "slackChannels": [
- {
- "name": "engineering",
- "notificationsEnabled": true
}
], - "additionalMembers": [
- {
- "name": "Aditya Manager",
- "email": "aditya-m@cortex.io"
}
], - "idpGroup": {
- "group": "cortexapps/engineering",
- "provider": "GIT"
}
}
Response samples
- 200
- 400
Content type
application/json
Example
Team backed by an identity provider
{- "type": "idp",
- "teamTag": "cortexapps-engineering",
- "metadata": {
- "name": "Cortex Engineering Team",
- "description": "Cortex Engineers",
- "summary": "This main engineering team that reviews all the code"
}, - "links": [
], - "slackChannels": [
- {
- "name": "engineering",
- "notificationsEnabled": true
}
], - "additionalMembers": [
- {
- "name": "Aditya Manager",
- "email": "aditya-m@cortex.io"
}
], - "idpGroup": {
- "group": "cortexapps/engineering",
- "provider": "GIT"
}
}
Update an existing department
Authorizations:
bearerAuth
query Parameters
departmentTag required | string |
Request Body schema: application/json
name | string |
description | string |
Array of objects (PublicDepartmentMemberRequest) |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "string",
- "description": "string",
- "members": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
]
}
Response samples
- 200
- 400
- 404
Content type
application/json
{- "departmentTag": "string",
- "name": "string",
- "description": "string",
- "members": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
]
}
Create a department
Authorizations:
bearerAuth
Request Body schema: application/json
departmentTag | string |
name | string |
description | string |
Array of objects (PublicDepartmentMemberRequest) |
Responses
Request samples
- Payload
Content type
application/json
{- "departmentTag": "string",
- "name": "string",
- "description": "string",
- "members": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
]
}
Response samples
- 200
- 400
Content type
application/json
{- "departmentTag": "string",
- "name": "string",
- "description": "string",
- "members": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
]
}
Get department by identifier
Authorizations:
bearerAuth
query Parameters
departmentTag required | string |
Responses
Response samples
- 200
- 404
Content type
application/json
{- "departmentTag": "string",
- "name": "string",
- "description": "string",
- "members": [
- {
- "name": "string",
- "email": "string",
- "description": "string"
}
]
}
Bulk replace team relationships
Authorizations:
bearerAuth
query Parameters
replace required | boolean |
Request Body schema: application/json
Array of objects (PublicTeamEdge) | |||||
Array
|
Responses
Request samples
- Payload
Content type
application/json
{- "edges": [
- {
- "parentTeamTag": "string",
- "childTeamTag": "string"
}
]
}
Response samples
- 200
- 400
Content type
application/json
{- "edges": [
- {
- "parentTeamTag": "string",
- "childTeamTag": "string"
}
]
}