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:

bearerAuth

path Parameters

uuid

required

string

Request Body schema: application/json

object (JsonNode)

Responses

Request samples

Payload

Content type

application/json

{ }

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"
}
]
}

Get service custom data

Authorizations:

bearerAuth

path Parameters

tag

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"
}
]

Add service 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"
}

Add service 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"
}

Deploys

Get service deployments

Authorizations:

bearerAuth

path Parameters

tag

required

string

Responses

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 service 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"
}
}

Packages

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,
"serviceId": 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,
"serviceId": 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,
"serviceId": 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

Authorizations:

bearerAuth

path Parameters

tag

required

string

Request Body schema: application/json

Array

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,
"serviceId": 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,
"serviceId": 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,
"serviceId": 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,
"serviceId": 0,
"packageType": "NODE",
"name": "string",
"version": "string",
"dateCreated": "2019-08-24T14:15:22Z"
}
]

Get service packages

Authorizations:

bearerAuth

path Parameters

tag

required

string

Responses

Response samples

200
404

Content type

application/json

[{"id": 0,
"serviceId": 0,
"packageType": "NODE",
"name": "string",
"version": "string",
"dateCreated": "2019-08-24T14:15:22Z"
}
]

Scorecards

Update Scorecard Rules

Authorizations:

bearerAuth

path Parameters

id

required

integer <int64>

Request Body schema: application/json

Array of objects (PublicScorecardRule)

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"
}
]
}

Get all scores

Authorizations:

bearerAuth

path Parameters

id

required

integer <int64>

Responses

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"
}
]
}
}
]
}

Get service scorecard scores

Authorizations:

bearerAuth

path Parameters

tag

required

string

Responses

Response samples

200
404

Content type

application/json

[{"scorecardId": 0,
"scorecardName": "string",
"scorePercentage": 0,
"score": 0,
"totalPossibleScore": 0,
"ladderLevels": [{"level": {"name": "string",
"number": 0
}
}
]
}
]

Service Group Hierarchy

Bulk replace Service Group Relationships

Authorizations:

bearerAuth

Request Body schema: application/json

Array of objects (PublicServiceGroupRelationship)

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"
}
]
}

Delete Service Group Relationship

Authorizations:

bearerAuth

query Parameters

parent	string
child	string

Responses

Response samples

200
404

Content type

application/json

{"relationships": [{"parent": "string",
"child": "string"
}
]
}

Catalog

Retrieve data for a single service

Authorizations:

bearerAuth

path Parameters

tag

required

string

Responses

Delete Service

Authorizations:

bearerAuth

path Parameters

tag

required

string

Responses

Response samples

404

Content type

application/json

{"type": "INTEGRATION_MISSING",
"message": "string",
"httpStatus": 0,
"details": "string",
"gatewayHttpStatus": 0,
"requestId": "string"
}

Get Service OpenAPI Spec

Authorizations:

bearerAuth

path Parameters

tag

required

string

Responses

Response samples

404

Content type

application/json

{"type": "INTEGRATION_MISSING",
"message": "string",
"httpStatus": 0,
"details": "string",
"gatewayHttpStatus": 0,
"requestId": "string"
}

allServices

Authorizations:

bearerAuth