Login to CortexBook a DemoCortex Academycortex.ioCortex Status

Packages

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
get
GET /api/v1/catalog/{tagOrId}/packages HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

[
  {
    "dateCreated": "2025-06-28T19:23:14.615Z",
    "id": 1,
    "name": "text",
    "packageType": "NODE",
    "version": "text"
  }
]

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

[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
delete
DELETE /api/v1/catalog/{tagOrId}/packages/dotnet/nuget HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

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

[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
delete
DELETE /api/v1/catalog/{tagOrId}/packages/go HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

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

[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
delete
DELETE /api/v1/catalog/{tagOrId}/packages/java HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

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

[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
delete
DELETE /api/v1/catalog/{tagOrId}/packages/node HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

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

[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
delete
DELETE /api/v1/catalog/{tagOrId}/packages/python HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

Last updated

Was this helpful?