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

Packages

Last updated 1 month ago

Was this helpful?

Use these operations to interact with packages in Cortex.

Required permissions

Your API key must have the Edit entities permission.

Operations

List packages

get
Authorizations
Path parameters
tagOrIdstringRequired

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

Query parameters
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
All packages. If using pagination, we do not return page, total, or totalPages in the response. An empty array is returned once you reach the end.
application/json
404
Entity 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/catalog/{tagOrId}/packages HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*
[
  {
    "dateCreated": "2025-05-20T05:18:50.991Z",
    "id": 1,
    "name": "text",
    "packageType": "NODE",
    "version": "text"
  }
]

[csharp] Delete Nuget package

delete
Authorizations
Path parameters
tagOrIdstringRequired

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

Query parameters
namestringRequired
Responses
200
Successfully deleted package
404
Entity 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/catalog/{tagOrId}/packages/dotnet/nuget HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

[go] Delete Go package

delete
Authorizations
Path parameters
tagOrIdstringRequired

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

Query parameters
namestringRequired
Responses
200
Successfully deleted package
404
Entity 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/catalog/{tagOrId}/packages/go HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

[java] Delete Java package

delete
Authorizations
Path parameters
tagOrIdstringRequired

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

Query parameters
namestringRequired
Responses
200
Successfully deleted package
404
Entity 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/catalog/{tagOrId}/packages/java HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

[node] Delete Node package

delete
Authorizations
Path parameters
tagOrIdstringRequired

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

Query parameters
namestringRequired
Responses
200
Successfully deleted package
404
Entity 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/catalog/{tagOrId}/packages/node HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

[python] Delete Python package

delete
Authorizations
Path parameters
tagOrIdstringRequired

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

Query parameters
namestringRequired
Responses
200
Successfully deleted package
404
Entity 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/catalog/{tagOrId}/packages/python HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

  • Required permissions
  • Operations
  • GETList packages
  • POST[csharp] Upload Nuget csproj
  • POST[csharp] Upload Nuget packages.lock.json
  • DELETE[csharp] Delete Nuget package
  • POST[golang] Upload go.sum
  • DELETE[go] Delete Go package
  • POST[java] Upload single Java package
  • POST[java] Upload multiple Java packages
  • POST[java] Upload maven pom.xml
  • DELETE[java] Delete Java package
  • POST[js] Upload NPM/Yarn/PNPM package.json
  • POST[js] Upload NPM package-lock.json
  • DELETE[node] Delete Node package
  • POST[js] Upload pnpm-lock.yaml
  • POST[js] Upload yarn.lock
  • POST[python] Upload pipfile.lock
  • POST[python] Upload requirements.txt
  • DELETE[python] Delete Python package

[csharp] Upload Nuget csproj

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
stringOptional
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/dotnet/nuget/csproj HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "NUGET",
    "version": "string"
  }
]

[csharp] Upload Nuget packages.lock.json

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
stringOptional
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/dotnet/nuget/packages-lock HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "NUGET",
    "version": "string"
  }
]

[golang] Upload go.sum

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
stringOptional
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/go/gosum HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "GO",
    "version": "string"
  }
]

[java] Upload single Java package

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
namestringRequired

Package name, like io.cortex.scorecards

Example: io.cortex.scorecards
versionstringRequired

Semver package version

Example: 1.2.3
Responses
200
Successfully saved package
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/java HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "name": "io.cortex.scorecards",
  "version": "1.2.3"
}
{
  "dateCreated": "2023-01-01T01:01:01.000Z",
  "id": 0,
  "name": "string",
  "packageType": "JAVA",
  "version": "string"
}

[java] Upload multiple Java packages

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
namestringRequired

Package name, like io.cortex.scorecards

Example: io.cortex.scorecards
versionstringRequired

Semver package version

Example: 1.2.3
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/java/bulk HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 51

[
  {
    "name": "io.cortex.scorecards",
    "version": "1.2.3"
  }
]
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "JAVA",
    "version": "string"
  }
]

[java] Upload maven pom.xml

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
stringOptional
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/java/maven-pom HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "JAVA",
    "version": "string"
  }
]

[js] Upload NPM/Yarn/PNPM package.json

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
stringOptional
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/node/package-json HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "NODE",
    "version": "string"
  }
]

[js] Upload NPM package-lock.json

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
stringOptional
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/node/package-lock HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "NODE",
    "version": "string"
  }
]

[js] Upload pnpm-lock.yaml

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
stringOptional
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/node/pnpm-lock HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "NODE",
    "version": "string"
  }
]

[js] Upload yarn.lock

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
stringOptional
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/node/yarn-lock HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "NODE",
    "version": "string"
  }
]

[python] Upload pipfile.lock

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
stringOptional
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/python/pipfile HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "PYTHON",
    "version": "string"
  }
]

[python] Upload requirements.txt

post
Authorizations
Path parameters
tagOrIdstringRequired

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

Body
stringOptional
Responses
200
Successfully saved packages
application/json
404
Entity 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
post
POST /api/v1/catalog/{tagOrId}/packages/python/requirements HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"
[
  {
    "dateCreated": "2023-01-01T01:01:01.000Z",
    "id": 0,
    "name": "string",
    "packageType": "PYTHON",
    "version": "string"
  }
]