LogoLogo
Login to CortexBook a DemoCortex Academycortex.io
  • Cortex Docs
  • Cortex Quick Start
  • Ingesting data into Cortex
    • Managing Entities
      • Adding entities
        • Add services
        • Add domains
        • Add teams
        • Add custom entity types
        • Defining dependencies
      • Entity details page
      • Defining ownership
      • Defining relationship types
      • Grouping entities
      • Adding external documentation
      • Adding Deploy data
      • Adding custom data
      • Viewing discovered entities
      • Archiving entities
      • Relationship graph
      • Using On-call Assistant for incidents
      • Managing Terraform infra in Cortex
    • Managing Catalogs
    • Integrations
      • Internally hosted integrations
      • ArgoCD
      • AWS
      • Azure DevOps
      • Azure Resources
      • BambooHR
      • Bitbucket
      • BugSnag
      • Buildkite
      • Checkmarx
      • CircleCI
      • ClickUp
      • Codecov
      • Coralogix
      • Custom webhook integrations
      • Datadog
      • Dynatrace
      • Entra ID (Azure AD)
      • FireHydrant
      • GitHub
      • GitLab
      • Google
      • Grafana
      • incident.io
      • Instana
      • Jenkins
      • Jira
      • Kubernetes
      • LaunchDarkly
      • Lightstep
      • Mend
      • Microsoft Teams
      • New Relic
      • Okta
      • Opsgenie
      • PagerDuty
      • Prometheus
      • Rollbar
      • Rootly
      • Sentry
      • ServiceNow
      • Slack
      • Snyk
      • SonarQube
      • Splunk Observability Cloud (SignalFx)
      • Splunk On-Call (VictorOps)
      • Sumo Logic
      • Veracode
      • Wiz
      • Workday
      • xMatters
  • Scorecards
    • Initiatives and Action items
      • Creating issues based on Initiatives
    • Scorecard rule exemptions
    • Scorecard rule filters
    • Scorecard examples
    • Scorecards as code
  • Reports
    • Executive report
    • All Scorecards report
    • Bird's eye report
    • Progress report
    • Report card
  • Eng Intelligence
    • Custom Metrics
    • Jira Metrics
    • Metrics Explorer (Beta)
  • Cortex Query Language (CQL)
    • Using CQL reports
    • Using JQ in Cortex
  • Workflows
    • Creating a Workflow
      • Workflows as code
    • Blocks
    • Running a Workflow
    • Registering a Scaffolder template
      • Scaffolder advanced usage
    • Using a Workflow to sync in ArgoCD
    • Kicking off a Jenkins pipeline in a Workflow
    • Calling internal service endpoints in a Workflow
  • Plugins
    • Creating a plugin
      • Creating a plugin proxy
    • Migrating Backstage plugins to Cortex
  • Engineering homepage
  • Workspace Settings
    • Using GitOps for Cortex
      • GitOps logs
    • Managing users
      • Roles and permissions
        • Custom roles
        • Team ownership entity editing
      • Configuring SSO
        • Microsoft Entra ID
        • Google
        • Other OIDC providers
        • Okta
          • Okta SCIM
      • Configuring identity mappings
      • Onboarding management
    • API keys, secrets, and tokens
      • Secrets
      • Personal tokens
    • Audit logs
    • Entity settings
      • Data verification
      • Auto archiving entities
    • IP allowlist
    • Notifications
      • Notification logs
    • Customizing your workspace
    • Using search in Cortex
  • Cortex API
    • REST API operations
      • API Keys
      • Audit Logs
      • Catalog Entities
      • Custom Data
        • Custom Data (Advanced)
      • Custom Events
      • Custom Metrics
      • Dependencies
      • Deploys
      • Discovery Audit
      • Docs
      • Eng Intel: User Labels
      • Entity Relationship Types (Beta)
      • Entity Relationships (Beta)
      • Entity Types
      • GitOps Logs
      • Groups
      • Initiatives
      • Integrations APIs
        • Azure Active Directory (Entra ID) API
        • Azure Resources API
        • AWS API
        • Azure DevOps API
        • CircleCI API
        • Coralogix API
        • Datadog API
        • GitHub API
        • GitLab API
        • incident.io API
        • LaunchDarkly API
        • New Relic API
        • PagerDuty API
        • Prometheus API
        • SonarQube API
      • IP Allowlist
      • Notification Logs
      • On call
      • Packages
      • Plugins
      • Queries
      • SCIM
      • Scorecards
      • Secrets
      • Team Hierarchies
      • Teams
      • Workflows
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Cortex API
  2. REST API operations

Initiatives

Last updated 1 month ago

Was this helpful?

Use these operations to interact with in Cortex.

Required permissions

  • Create, read, update, or delete Initiatives: Your API key must have the Edit Initiatives permission.

  • View Initiatives: Your API key must have the View Initiatives permission.

Operations

Initiatives

List Initiatives

get

Retrieves a list of Initiatives.

API key must have the View Initiatives permission.

Authorizations
Query parameters
includeDraftsbooleanOptional

Whether or not to include draft Initiatives in the response

Default: false
includeExpiredbooleanOptional

Whether or not to include expired Initiatives in the response

Default: false
pageSizeinteger · int32Required

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

Default: 250
pageinteger · int32Required

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

Default: 0
Responses
200
Successfully retrieved Initiatives
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
get
GET /api/v1/initiatives HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
  "initiatives": [
    {
      "cid": "in2da8159dbeefb974",
      "description": "text",
      "emphasizedLevels": [
        {
          "color": "text",
          "name": "text",
          "rank": 1
        }
      ],
      "emphasizedRules": [
        {
          "description": "text",
          "expression": "text",
          "title": "text"
        }
      ],
      "filter": {
        "groups": {
          "exclude": [
            "text"
          ],
          "include": [
            "text"
          ]
        },
        "query": "text",
        "types": {
          "exclude": [
            "text"
          ],
          "include": [
            "text"
          ]
        }
      },
      "isDraft": true,
      "name": "text",
      "notificationSchedule": {
        "isDisabled": true,
        "replyToEmails": [
          "text"
        ],
        "timeInterval": 1,
        "timeUnit": "text"
      },
      "scorecardName": "text",
      "scorecardTag": "text",
      "targetDate": "2025-05-20"
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Get Initiative

get

Get Initiative.

API key must have the View Initiatives permission.

Authorizations
Path parameters
cidstringRequired
Responses
200
Successfully retrieved Initiative
application/json
404
Initiative not found
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
get
GET /api/v1/initiatives/{cid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
{
  "cid": "in2da8159dbeefb974",
  "description": "text",
  "emphasizedLevels": [
    {
      "color": "text",
      "name": "text",
      "rank": 1
    }
  ],
  "emphasizedRules": [
    {
      "description": "text",
      "expression": "text",
      "title": "text"
    }
  ],
  "filter": {
    "groups": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    },
    "query": "text",
    "types": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    }
  },
  "isDraft": true,
  "name": "text",
  "notificationSchedule": {
    "isDisabled": true,
    "replyToEmails": [
      "text"
    ],
    "timeInterval": 1,
    "timeUnit": "text"
  },
  "scorecardName": "text",
  "scorecardTag": "text",
  "targetDate": "2025-05-20"
}

Delete Initiative

delete
Authorizations
Path parameters
cidstringRequired
Responses
200
Successfully deleted Initiative
404
Initiative not found
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
delete
DELETE /api/v1/initiatives/{cid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

  • Required permissions
  • Operations
  • GETList Initiatives
  • GETGet Initiative
  • POSTCreate an Initiative
  • PUTUpdate an Initiative
  • DELETEDelete Initiative

Create an Initiative

post

Create an Initiative.

API key must have the Edit Initiative permission.

Authorizations
Body
descriptionstringOptional

Optional description of the Initiative

isDraftbooleanRequired

Whether or not the Initiative is a draft

namestringRequired

Name of the Initiative

scorecardTagstringRequired

Tag of the scorecard associated with the Initiative

targetDatestring · dateRequired

Target date for the Initiative to be completed. Must be in the future

Responses
200
Successfully created Initiative
application/json
400
Bad Request
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
post
POST /api/v1/initiatives HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "description": "text",
  "emphasizedLevels": [
    {
      "rank": 1
    }
  ],
  "emphasizedRules": [
    {
      "expression": "text"
    }
  ],
  "filter": {
    "groups": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    },
    "query": "text",
    "types": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    }
  },
  "isDraft": true,
  "name": "text",
  "notificationSchedule": {
    "isDisabled": true,
    "replyToEmails": [
      "text"
    ],
    "timeInterval": 1,
    "timeUnit": "text"
  },
  "scorecardTag": "text",
  "targetDate": "2025-05-20"
}
{
  "cid": "in2da8159dbeefb974",
  "description": "text",
  "emphasizedLevels": [
    {
      "color": "text",
      "name": "text",
      "rank": 1
    }
  ],
  "emphasizedRules": [
    {
      "description": "text",
      "expression": "text",
      "title": "text"
    }
  ],
  "filter": {
    "groups": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    },
    "query": "text",
    "types": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    }
  },
  "isDraft": true,
  "name": "text",
  "notificationSchedule": {
    "isDisabled": true,
    "replyToEmails": [
      "text"
    ],
    "timeInterval": 1,
    "timeUnit": "text"
  },
  "scorecardName": "text",
  "scorecardTag": "text",
  "targetDate": "2025-05-20"
}

Update an Initiative

put

Update an Initiative.

API key must have the Edit Initiative permission.

Authorizations
Path parameters
cidstringRequired
Body
descriptionstringOptional

Optional description of the Initiative

isDraftbooleanRequired

Whether or not the Initiative is a draft

namestringRequired

Name of the Initiative

scorecardTagstringRequired

Tag of the scorecard associated with the Initiative

targetDatestring · dateRequired

Target date for the Initiative to be completed. Must be in the future

Responses
200
Successfully updated Initiative
application/json
400
Bad Request
application/json
404
Initiative not found
application/json
429
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
application/problem+json
put
PUT /api/v1/initiatives/{cid} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 399

{
  "description": "text",
  "emphasizedLevels": [
    {
      "rank": 1
    }
  ],
  "emphasizedRules": [
    {
      "expression": "text"
    }
  ],
  "filter": {
    "groups": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    },
    "query": "text",
    "types": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    }
  },
  "isDraft": true,
  "name": "text",
  "notificationSchedule": {
    "isDisabled": true,
    "replyToEmails": [
      "text"
    ],
    "timeInterval": 1,
    "timeUnit": "text"
  },
  "scorecardTag": "text",
  "targetDate": "2025-05-20"
}
{
  "cid": "in2da8159dbeefb974",
  "description": "text",
  "emphasizedLevels": [
    {
      "color": "text",
      "name": "text",
      "rank": 1
    }
  ],
  "emphasizedRules": [
    {
      "description": "text",
      "expression": "text",
      "title": "text"
    }
  ],
  "filter": {
    "groups": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    },
    "query": "text",
    "types": {
      "exclude": [
        "text"
      ],
      "include": [
        "text"
      ]
    }
  },
  "isDraft": true,
  "name": "text",
  "notificationSchedule": {
    "isDisabled": true,
    "replyToEmails": [
      "text"
    ],
    "timeInterval": 1,
    "timeUnit": "text"
  },
  "scorecardName": "text",
  "scorecardTag": "text",
  "targetDate": "2025-05-20"
}