Skip to main content

Cortex API (v1)

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Custom Data

Send data to Custom Data Webhook

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

Responses

Request samples

Content type
application/json
{ }

Bulk Upload Custom Data

Authorizations:
query Parameters
force
boolean
Request Body schema: application/json
object

Responses

Request samples

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

Response samples

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

Get service custom data

Authorizations:
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add service custom data

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

Add service custom data

Authorizations:
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 service deployments

Authorizations:
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add service deployment

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

Packages

Upload requirements.txt packages

Authorizations:
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:
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:
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:
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:
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:
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:
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:
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 service packages

Authorizations:
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Scorecards

Update Scorecard Rules

Authorizations:
path Parameters
id
required
integer <int64>
Request Body schema: application/json
Array of objects (PublicScorecardRule)

Responses

Request samples

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

Response samples

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

Get all scores

Authorizations:
path Parameters
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "scorecardId": 0,
  • "serviceScores": [
    ]
}

Get service scorecard scores

Authorizations:
path Parameters
tag
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Service Group Hierarchy

Bulk replace Service Group Relationships

Authorizations:
Request Body schema: application/json
Array of objects (PublicServiceGroupRelationship)

Responses

Request samples

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

Response samples

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

Delete Service Group Relationship

Authorizations:
query Parameters
parent
string
child
string

Responses

Response samples

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

Catalog

Retrieve data for a single service

Authorizations:
path Parameters
tag
required
string

Responses

Delete Service

Authorizations:
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 Service OpenAPI Spec

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

allServices

Authorizations:

Responses