Scorecards

List Scorecards

get

Authorizations

Query parameters

showDraftsbooleanoptional

pageinteger · int32 · default: 0required

Page number to return, 0-indexed. Default 0.

pageSizeinteger · int32 · default: 250required

Number of results to return per page, between 1 and 1000. Default 250.

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/scorecards?page=1&pageSize=1' \
  --header 'Authorization: Bearer JWT'

200

429

{
  "page": 1,
  "scorecards": [
    {
      "description": "text",
      "evaluation": {
        "window": 4
      },
      "exemptions": {
        "autoApprove": false,
        "enabled": true
      },
      "filter": {
        "groups": {
          "exclude": [
            "text"
          ],
          "include": [
            "text"
          ]
        },
        "query": "text",
        "types": {
          "exclude": [
            "text"
          ],
          "include": [
            "text"
          ]
        }
      },
      "isDraft": true,
      "lastUpdated": "2025-03-29T00:52:31.796Z",
      "levels": [
        {
          "level": {
            "name": "Bronze",
            "number": 1
          }
        }
      ],
      "name": "Production Readiness Scorecard",
      "notifications": {
        "enabled": true,
        "scoreDropNotificationsEnabled": true
      },
      "rules": [
        {
          "description": "This rule is very important because you must pass it",
          "effectiveFrom": "2024-01-01T00:00:00Z",
          "expression": "custom(\"key\") = \"value\"",
          "failureMessage": "To fix this rule, visit [our internal doc][docs.cortex.io]",
          "filter": {
            "groups": {
              "exclude": [
                "text"
              ],
              "include": [
                "text"
              ]
            },
            "query": "text",
            "types": {
              "exclude": [
                "text"
              ],
              "include": [
                "text"
              ]
            }
          },
          "identifier": "96db03f1-2529-3fc3-9f13-7fb4dd28f427",
          "levelName": "text",
          "title": "Key value must be correct",
          "weight": 1
        }
      ],
      "tag": "production-readiness-scorecard"
    }
  ],
  "total": 1,
  "totalPages": 1
}

Retrieve Scorecard scores

get

Returns latest scores for all entities in the Scorecard

Authorizations

Path parameters

tagstringrequired

Unique tag for the Scorecard

Example: my-production-readiness-checklist

Query parameters

entityTagstringoptional

Entity tag (x-cortex-tag)

pageSizeinteger · int32 · default: 250required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger · int32 · default: 0required

Page number to return, 0-indexed. Default 0.

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/{tag}/scores?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

404

429

{
  "scorecardFilter": {
    "groups": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    },
    "query": "text",
    "types": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    }
  },
  "scorecardName": "text",
  "scorecardTag": "text",
  "serviceScores": [
    {
      "lastEvaluated": "2025-03-29T00:52:31.796Z",
      "ruleExemptions": "[Circular Reference]",
      "score": {
        "ladderLevels": [
          {
            "level": {
              "name": "Bronze",
              "number": 1
            }
          }
        ],
        "rules": [
          {
            "error": "text",
            "expression": "text",
            "identifier": "text",
            "score": 1
          }
        ],
        "summary": {
          "percentage": 1,
          "score": 1,
          "totalPossibleScore": 1
        }
      },
      "service": {
        "groups": [
          "text"
        ],
        "id": "en2da8159dbeefb974",
        "name": "My Favorite Entity",
        "owners": {
          "groups": [
            "text"
          ],
          "individuals": [
            {
              "description": "text",
              "email": "text"
            }
          ]
        },
        "tag": "my-favorite-entity"
      }
    }
  ]
}

Scorecard scores

Retrieve entity Scorecard scores

get

Authorizations

Path parameters

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/catalog/{tagOrId}/scorecards' \
  --header 'Authorization: Bearer JWT'

200

404

429

[
  {
    "ladderLevels": [
      {
        "level": {
          "name": "Bronze",
          "number": 1
        }
      }
    ],
    "score": 1,
    "scorePercentage": 1,
    "scorecardName": "text",
    "totalPossibleScore": 1
  }
]

All entity Scorecard scores

Retrieve Scorecard

get

Authorizations

Path parameters

tagstringrequired

Unique tag for the Scorecard

Example: my-production-readiness-checklist

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/{tag}' \
  --header 'Authorization: Bearer JWT'

200

404

429

{
  "scorecard": {
    "description": "text",
    "evaluation": {
      "window": 4
    },
    "exemptions": {
      "autoApprove": false,
      "enabled": true
    },
    "filter": {
      "groups": {
        "exclude": [
          "text"
        ],
        "include": [
          "text"
        ]
      },
      "query": "text",
      "types": {
        "exclude": [
          "text"
        ],
        "include": [
          "text"
        ]
      }
    },
    "isDraft": true,
    "lastUpdated": "2025-03-29T00:52:31.796Z",
    "levels": [
      {
        "level": {
          "name": "Bronze",
          "number": 1
        }
      }
    ],
    "name": "Production Readiness Scorecard",
    "notifications": {
      "enabled": true,
      "scoreDropNotificationsEnabled": true
    },
    "rules": [
      {
        "description": "This rule is very important because you must pass it",
        "effectiveFrom": "2024-01-01T00:00:00Z",
        "expression": "custom(\"key\") = \"value\"",
        "failureMessage": "To fix this rule, visit [our internal doc][docs.cortex.io]",
        "filter": {
          "groups": {
            "exclude": [
              "text"
            ],
            "include": [
              "text"
            ]
          },
          "query": "text",
          "types": {
            "exclude": [
              "text"
            ],
            "include": [
              "text"
            ]
          }
        },
        "identifier": "96db03f1-2529-3fc3-9f13-7fb4dd28f427",
        "levelName": "text",
        "title": "Key value must be correct",
        "weight": 1
      }
    ],
    "tag": "production-readiness-scorecard"
  }
}

Successfully retrieved Scorecard

Retrieve Scorecard descriptor

get

Authorizations

Path parameters

tagstringrequired

Unique tag for the Scorecard

Example: my-production-readiness-checklist

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/{tag}/descriptor' \
  --header 'Authorization: Bearer JWT'

200

404

429

text

Successfully retrieved Scorecard descriptor

Retrieve Scorecard shields.io badge

get

Authorizations

Path parameters

scorecardTagstringrequired

Unique tag for the Scorecard.

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/{scorecardTag}/entity/{tagOrId}/badge' \
  --header 'Authorization: Bearer JWT'

200

404

429

{
  "value": "text"
}

Shields.io badge

Retrieve next steps for entity in Scorecard

get

Authorizations

Path parameters

tagstringrequired

Unique tag for the Scorecard

Example: my-production-readiness-checklist

Query parameters

entityTagstringrequired

The entity tag (x-cortex-tag) that identifies the entity.

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/{tag}/next-steps?entityTag=text' \
  --header 'Authorization: Bearer JWT'

200

404

429

{
  "nextSteps": [
    {
      "currentLevel": {
        "level": {
          "name": "Bronze",
          "number": 1
        }
      },
      "nextLevel": {
        "level": {
          "name": "Bronze",
          "number": 1
        }
      },
      "rulesToComplete": [
        {
          "description": "text",
          "expression": "text",
          "identifier": "text",
          "title": "text"
        }
      ]
    }
  ]
}

Any rules remaining for the entity to reach the next level in the Scorecard.

Create or update Scorecard

post

Create or update a Scorecard using the descriptor YAML. The operation is determined by the existence of a Scorecard with the same tag as passed in the descriptor.

Authorizations

Query parameters

dryRunbooleanoptional

When true, this endpoint only validates the descriptor contents and returns any errors or warnings.

Body

anyoptional

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/descriptor' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/yaml;charset=UTF-8'

200

400

429

{
  "scorecard": {
    "description": "text",
    "evaluation": {
      "window": 4
    },
    "exemptions": {
      "autoApprove": false,
      "enabled": true
    },
    "filter": {
      "groups": {
        "exclude": [
          "text"
        ],
        "include": [
          "text"
        ]
      },
      "query": "text",
      "types": {
        "exclude": [
          "text"
        ],
        "include": [
          "text"
        ]
      }
    },
    "isDraft": true,
    "lastUpdated": "2025-03-29T00:52:31.796Z",
    "levels": [
      {
        "level": {
          "name": "Bronze",
          "number": 1
        }
      }
    ],
    "name": "Production Readiness Scorecard",
    "notifications": {
      "enabled": true,
      "scoreDropNotificationsEnabled": true
    },
    "rules": [
      {
        "description": "This rule is very important because you must pass it",
        "effectiveFrom": "2024-01-01T00:00:00Z",
        "expression": "custom(\"key\") = \"value\"",
        "failureMessage": "To fix this rule, visit [our internal doc][docs.cortex.io]",
        "filter": {
          "groups": {
            "exclude": [
              "text"
            ],
            "include": [
              "text"
            ]
          },
          "query": "text",
          "types": {
            "exclude": [
              "text"
            ],
            "include": [
              "text"
            ]
          }
        },
        "identifier": "96db03f1-2529-3fc3-9f13-7fb4dd28f427",
        "levelName": "text",
        "title": "Key value must be correct",
        "weight": 1
      }
    ],
    "tag": "production-readiness-scorecard"
  }
}

Created Scorecard

Delete Scorecard

delete

Authorizations

Path parameters

tagstringrequired

Unique tag for the Scorecard

Example: my-production-readiness-checklist

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/{tag}' \
  --header 'Authorization: Bearer JWT'

200

404

429

No body

Successfully deleted Scorecard

Request Scorecard rule exemption

post

Request Scorecard rule exemption

Authorizations

Path parameters

tagstringrequired

Unique tag for the Scorecard

Example: my-production-readiness-checklist

entityTagstringrequired

The entity tag (x-cortex-tag) that identifies the entity.

Body

daysinteger · int64 | nullableoptional

Number of days how long rule should be exempt. If not set, rule will be exempt until exempt until revoked.

reasonstringrequired

Reason for creating exemption

ruleIdentifierstringrequired

Identifier of the Scorecard rule to request exemption for

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/{tag}/entity/{entityTag}/exemption' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "days": 1,
    "reason": "text",
    "ruleIdentifier": "text"
  }'

200

404

429

{
  "endDate": "2025-03-29T00:52:31.796Z",
  "exemptionStatus": {
    "date": "2025-03-29T00:52:31.796Z",
    "handledBy": {
      "0": "[",
      "1": "C",
      "2": "i",
      "3": "r",
      "4": "c",
      "5": "u",
      "6": "l",
      "7": "a",
      "8": "r",
      "9": " ",
      "10": "R",
      "11": "e",
      "12": "f",
      "13": "e",
      "14": "r",
      "15": "e",
      "16": "n",
      "17": "c",
      "18": "e",
      "19": "]",
      "type": "text"
    },
    "status": "text"
  },
  "requestedBy": {
    "0": "[",
    "1": "C",
    "2": "i",
    "3": "r",
    "4": "c",
    "5": "u",
    "6": "l",
    "7": "a",
    "8": "r",
    "9": " ",
    "10": "R",
    "11": "e",
    "12": "f",
    "13": "e",
    "14": "r",
    "15": "e",
    "16": "n",
    "17": "c",
    "18": "e",
    "19": "]",
    "type": "text",
    "email": "text",
    "name": "text"
  },
  "requestedDate": "2025-03-29T00:52:31.796Z",
  "requestingReason": "text"
}

Successfully requested Scorecard rule exemption

Revoke Scorecard rule exemption

put

Revoke Scorecard rule exemption

Authorizations

Path parameters

tagstringrequired

Unique tag for the Scorecard

Example: my-production-readiness-checklist

entityTagstringrequired

The entity tag (x-cortex-tag) that identifies the entity.

Body

reasonstringrequired

ruleIdentifierstringrequired

Identifier of the Scorecard rule

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/{tag}/entity/{entityTag}/exemption/revoke' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "reason": "text",
    "ruleIdentifier": "text"
  }'

200

400

404

429

{
  "exemptions": [
    {
      "endDate": "2025-03-29T00:52:31.796Z",
      "exemptionStatus": {
        "date": "2025-03-29T00:52:31.796Z",
        "handledBy": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]",
          "type": "text"
        },
        "status": "text"
      },
      "requestedBy": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]",
        "type": "text",
        "email": "text",
        "name": "text"
      },
      "requestedDate": "2025-03-29T00:52:31.796Z",
      "requestingReason": "text"
    }
  ]
}

Revoked Scorecard rule exemptions

Approve Scorecard rule exemption

put

Approve Scorecard rule exemption

Authorizations

Path parameters

tagstringrequired

Unique tag for the Scorecard

Example: my-production-readiness-checklist

entityTagstringrequired

The entity tag (x-cortex-tag) that identifies the entity.

Body

ruleIdentifierstringrequired

Identifier of the Scorecard rule

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/{tag}/entity/{entityTag}/exemption/approve' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "ruleIdentifier": "text"
  }'

200

400

404

429

{
  "exemptions": [
    {
      "endDate": "2025-03-29T00:52:31.796Z",
      "exemptionStatus": {
        "date": "2025-03-29T00:52:31.796Z",
        "handledBy": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]",
          "type": "text"
        },
        "status": "text"
      },
      "requestedBy": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]",
        "type": "text",
        "email": "text",
        "name": "text"
      },
      "requestedDate": "2025-03-29T00:52:31.796Z",
      "requestingReason": "text"
    }
  ]
}

Successfully approved Scorecard rule exemptions

Deny Scorecard rule exemption

put

Deny Scorecard rule exemption

Authorizations

Path parameters

tagstringrequired

Unique tag for the Scorecard

Example: my-production-readiness-checklist

entityTagstringrequired

The entity tag (x-cortex-tag) that identifies the entity.

Body

reasonstringrequired

ruleIdentifierstringrequired

Identifier of the Scorecard rule

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.getcortexapp.com/api/v1/scorecards/{tag}/entity/{entityTag}/exemption/deny' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "reason": "text",
    "ruleIdentifier": "text"
  }'

200

400

404

429

{
  "exemptions": [
    {
      "endDate": "2025-03-29T00:52:31.796Z",
      "exemptionStatus": {
        "date": "2025-03-29T00:52:31.796Z",
        "handledBy": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]",
          "type": "text"
        },
        "status": "text"
      },
      "requestedBy": {
        "0": "[",
        "1": "C",
        "2": "i",
        "3": "r",
        "4": "c",
        "5": "u",
        "6": "l",
        "7": "a",
        "8": "r",
        "9": " ",
        "10": "R",
        "11": "e",
        "12": "f",
        "13": "e",
        "14": "r",
        "15": "e",
        "16": "n",
        "17": "c",
        "18": "e",
        "19": "]",
        "type": "text",
        "email": "text",
        "name": "text"
      },
      "requestedDate": "2025-03-29T00:52:31.796Z",
      "requestingReason": "text"
    }
  ]
}

Denied Scorecard rule exemptions

Required permissions

Operations

Required permissions

Operations

List Scorecards

Retrieve Scorecard scores

Retrieve entity Scorecard scores

Retrieve Scorecard

Retrieve Scorecard descriptor

Retrieve Scorecard shields.io badge

Retrieve next steps for entity in Scorecard

Create or update Scorecard

Delete Scorecard

Request Scorecard rule exemption

Revoke Scorecard rule exemption

Approve Scorecard rule exemption

Deny Scorecard rule exemption