Skip to main content

Cortex API (v1)

Download OpenAPI specification:Download

Custom Data

Send data to Custom Data Webhook

Authorizations:
bearerAuth
path Parameters
uuid
required
string
Request Body schema: application/json
object (JsonNode)

Responses

Request samples

Content type
application/json
{ }

Bulk Upload Custom Data

Authorizations:
bearerAuth
query Parameters
force
boolean
Request Body schema: application/json
object
additional property
Array of objects (DataCreateRequest)
Array
key
string
value
object (CustomDataType)
description
string

Responses

Request samples

Content type
application/json
{
  • "values": {
    }
}

Response samples

Content type
application/json
{
  • "values": [
    ]
}

Get custom data

Authorizations:
bearerAuth
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "key": "string",
  • "value": { },
  • "description": "string"
}

Response samples

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

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Deploys

Get deployments

Authorizations:
bearerAuth
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "title": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "type": "DEPLOY",
  • "sha": "string",
  • "deployer": {
    },
  • "environment": "string",
  • "customData": {
    }
}

Response samples

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": {
    }
}

Delete deployments with filters

Authorizations:
bearerAuth
query Parameters
environment
string
sha
string
type
string
Enum: "DEPLOY" "SCALE" "ROLLBACK" "RESTART"

Responses

Response samples

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Delete all deployments

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Packages

Upload requirements.txt packages

Authorizations:
bearerAuth
path Parameters
tag
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
[
  • {
    }
]

Upload pipfile.lock packages

Authorizations:
bearerAuth
path Parameters
tag
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
[
  • {
    }
]

Upload Java package version

Authorizations:
bearerAuth
path Parameters
tag
required
string
Request Body schema: application/json
name
string
version
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "version": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete Java package version

Authorizations:
bearerAuth
path Parameters
tag
required
string
query Parameters
name
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Bulk upload Nuget package versions

Authorizations:
bearerAuth
path Parameters
tag
required
string
Request Body schema: application/json
Array
name
string
version
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Upload package.lock packages

Authorizations:
bearerAuth
path Parameters
tag
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
[
  • {
    }
]

Upload yarn.lock packages

Authorizations:
bearerAuth
path Parameters
tag
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
[
  • {
    }
]

Upload go.sum packages

Authorizations:
bearerAuth
path Parameters
tag
required
string
Request Body schema: application/json
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json
[
  • {
    }
]

Get packages

Authorizations:
bearerAuth
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scorecards

Update Scorecard Rules

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>
Request Body schema: application/json
Array of objects (PublicScorecardRule)
Array
expression
string
weight
number
description
string
title
string
failureMessage
string

Responses

Request samples

Content type
application/json
{
  • "rules": [
    ]
}

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Get all scores

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "scorecardId": 0,
  • "scorecardName": "string",
  • "scorePercentage": 0,
  • "score": 0,
  • "totalPossibleScore": 0,
  • "ladderLevels": [
    ]
}

Get service scorecard scores

Authorizations:
bearerAuth
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Groups

Get group memberships

Authorizations:
bearerAuth
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Bulk upload Group memberships

Authorizations:
bearerAuth
path Parameters
tag
required
string
Request Body schema: application/json
Array of objects (PublicGroupMembership)
Array
tag
string

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Delete Group memberships

Authorizations:
bearerAuth
path Parameters
tag
required
string
Request Body schema: application/json
Array of objects (PublicGroupMembership)
Array
tag
string

Responses

Request samples

Content type
application/json
{
  • "groups": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Group Hierarchy

Bulk replace Group Relationships

Authorizations:
bearerAuth
Request Body schema: application/json
Array of objects (PublicGroupRelationship)
Array
parent
string
child
string

Responses

Request samples

Content type
application/json
{
  • "relationships": [
    ]
}

Response samples

Content type
application/json
{
  • "relationships": [
    ]
}

Delete Group Relationship

Authorizations:
bearerAuth
query Parameters
parent
string
child
string

Responses

Response samples

Content type
application/json
{
  • "relationships": [
    ]
}

Catalog

Retrieve data for a single entity

Authorizations:
bearerAuth
path Parameters
tag
required
string

Responses

Delete Entity

Authorizations:
bearerAuth
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Get OpenAPI Spec

Authorizations:
bearerAuth
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Get All Entities

Authorizations:
bearerAuth
query Parameters
groups
Array of strings

Only return entities from these groups

gitRepositories
Array of strings

Only return entities registered to these repositories

types
Array of strings

Only return entities of the specified types

Responses

Dependencies

Bulk Upload Dependencies

Authorizations:
bearerAuth
Request Body schema: application/json
object
additional property
Array of objects (PublicBulkDependencyInnerRequest)
Array
tag
string
method
string
path
string
description
string
metadata
object (JsonNode)

Responses

Request samples

Content type
application/json
{
  • "values": {
    }
}

Response samples

Content type
application/json
{
  • "values": {
    }
}

Bulk Delete Dependencies

Authorizations:
bearerAuth
Request Body schema: application/json
object
additional property
Array of objects (PublicBulkDependencyInnerRequest)
Array
tag
string
method
string
path
string
description
string
metadata
object (JsonNode)

Responses

Request samples

Content type
application/json
{
  • "values": {
    }
}

Response samples

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

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

Content type
application/json
{
  • "description": "string",
  • "metadata": { }
}

Response samples

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

Content type
application/json
{
  • "description": "string",
  • "metadata": { }
}

Response samples

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

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Delete All Dependencies for Caller

Authorizations:
bearerAuth
path Parameters
callerTag
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Teams

Get team by identifier

Authorizations:
bearerAuth
query Parameters
teamTag
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "cortex",
  • "teamTag": "string",
  • "metadata": {
    },
  • "links": [
    ],
  • "slackChannels": [
    ],
  • "additionalMembers": [
    ],
  • "idpGroup": {
    },
  • "cortexTeam": {
    }
}

Delete team by identifier

Authorizations:
bearerAuth
query Parameters
teamTag
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Update an existing team's metadata

Authorizations:
bearerAuth
path Parameters
teamTag
required
string
Request Body schema: application/json

Responses

Request samples

Content type
application/json
Example

Update an existing idp team

{
  • "type": "idp",
  • "metadata": {
    },
  • "links": [],
  • "slackChannels": [
    ],
  • "additionalMembers": [
    ]
}

Response samples

Content type
application/json
Example

Team backed by an identity provider

{
  • "type": "idp",
  • "teamTag": "cortexapps-engineering",
  • "metadata": {
    },
  • "links": [],
  • "slackChannels": [
    ],
  • "additionalMembers": [
    ],
  • "idpGroup": {
    }
}

Update an existing cortex team's members

Authorizations:
bearerAuth
query Parameters
teamTag
required
string
Request Body schema: application/json

Responses

Request samples

Content type
application/json
No sample

Response samples

Content type
application/json
{
  • "type": "cortex",
  • "teamTag": "string",
  • "metadata": {
    },
  • "links": [
    ],
  • "slackChannels": [
    ],
  • "additionalMembers": [
    ],
  • "idpGroup": {
    },
  • "cortexTeam": {
    }
}

Get all teams

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "teams": [
    ]
}

Create a team

Authorizations:
bearerAuth
Request Body schema: application/json

Responses

Request samples

Content type
application/json
Example

Team backed by an identity provider

{
  • "type": "idp",
  • "teamTag": "cortexapps-engineering",
  • "metadata": {
    },
  • "links": [],
  • "slackChannels": [
    ],
  • "additionalMembers": [
    ],
  • "idpGroup": {
    }
}

Response samples

Content type
application/json
Example

Team backed by an identity provider

{
  • "type": "idp",
  • "teamTag": "cortexapps-engineering",
  • "metadata": {
    },
  • "links": [],
  • "slackChannels": [
    ],
  • "additionalMembers": [
    ],
  • "idpGroup": {
    }
}

Get all departments

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "departments": [
    ]
}

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

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "departmentTag": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ]
}

Create a department

Authorizations:
bearerAuth
Request Body schema: application/json
departmentTag
string
name
string
description
string
Array of objects (PublicDepartmentMemberRequest)

Responses

Request samples

Content type
application/json
{
  • "departmentTag": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "departmentTag": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ]
}

Get department by identifier

Authorizations:
bearerAuth
query Parameters
departmentTag
required
string

Responses

Response samples

Content type
application/json
{
  • "departmentTag": "string",
  • "name": "string",
  • "description": "string",
  • "members": [
    ]
}

Delete department by identifier

Authorizations:
bearerAuth
query Parameters
departmentTag
required
string

Responses

Response samples

Content type
application/json
{
  • "type": "INTEGRATION_MISSING",
  • "message": "string",
  • "httpStatus": 0,
  • "details": "string",
  • "gatewayHttpStatus": 0,
  • "requestId": "string"
}

Team Hierarchy

Get team relationships

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "edges": [
    ]
}

Bulk replace team relationships

Authorizations:
bearerAuth
query Parameters
replace
required
boolean
Request Body schema: application/json
Array of objects (PublicTeamEdge)
Array
parentTeamTag
string
childTeamTag
string

Responses

Request samples

Content type
application/json
{
  • "edges": [
    ]
}

Response samples

Content type
application/json
{
  • "edges": [
    ]
}