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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

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

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages

GET /api/v1/catalog/{tagOrId}/packages HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "dateCreated": "2026-01-01T00:00:00.000Z",
    "id": 1,
    "name": "text",
    "packageType": "NODE",
    "version": "text"
  }
]

[csharp] Upload Nuget csproj

post

Authorizations

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

stringOptional

Responses

200

Successfully saved packages

application/json

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

400

Unsupported csproj format, e.g. a .NET Framework project that declares dependencies with elements

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/api/v1/catalog/{tagOrId}/packages/dotnet/nuget/csproj

POST /api/v1/catalog/{tagOrId}/packages/dotnet/nuget/csproj HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/xml
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

stringOptional

Responses

200

Successfully saved packages

application/json

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/dotnet/nuget/packages-lock

POST /api/v1/catalog/{tagOrId}/packages/dotnet/nuget/packages-lock HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Query parameters

namestringRequired

Responses

200

Successfully deleted package

No content

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/api/v1/catalog/{tagOrId}/packages/dotnet/nuget

DELETE /api/v1/catalog/{tagOrId}/packages/dotnet/nuget?name=text HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

[golang] Upload go.sum

post

Authorizations

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

stringOptional

Responses

200

Successfully saved packages

application/json

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/go/gosum

POST /api/v1/catalog/{tagOrId}/packages/go/gosum HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Query parameters

namestringRequired

Responses

200

Successfully deleted package

No content

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/api/v1/catalog/{tagOrId}/packages/go

DELETE /api/v1/catalog/{tagOrId}/packages/go?name=text HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

[java] Upload single Java package

post

Authorizations

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

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

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/java

POST /api/v1/catalog/{tagOrId}/packages/java HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Bodyobject · PackageVersionRequest[]

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

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/java/bulk

POST /api/v1/catalog/{tagOrId}/packages/java/bulk HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

stringOptional

Responses

200

Successfully saved packages

application/json

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/java/maven-pom

POST /api/v1/catalog/{tagOrId}/packages/java/maven-pom HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Query parameters

namestringRequired

Responses

200

Successfully deleted package

No content

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/api/v1/catalog/{tagOrId}/packages/java

DELETE /api/v1/catalog/{tagOrId}/packages/java?name=text HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

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

post

Authorizations

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

stringOptional

Responses

200

Successfully saved packages

application/json

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/node/package-json

POST /api/v1/catalog/{tagOrId}/packages/node/package-json HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

stringOptional

Responses

200

Successfully saved packages

application/json

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/node/package-lock

POST /api/v1/catalog/{tagOrId}/packages/node/package-lock HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Query parameters

namestringRequired

Responses

200

Successfully deleted package

No content

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/api/v1/catalog/{tagOrId}/packages/node

DELETE /api/v1/catalog/{tagOrId}/packages/node?name=text HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

[js] Upload pnpm-lock.yaml

post

Authorizations

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

stringOptional

Responses

200

Successfully saved packages

application/json

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/node/pnpm-lock

POST /api/v1/catalog/{tagOrId}/packages/node/pnpm-lock HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

stringOptional

Responses

200

Successfully saved packages

application/json

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/node/yarn-lock

POST /api/v1/catalog/{tagOrId}/packages/node/yarn-lock HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

stringOptional

Responses

200

Successfully saved packages

application/json

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/python/pipfile

POST /api/v1/catalog/{tagOrId}/packages/python/pipfile HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
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

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

stringOptional

Responses

200

Successfully saved packages

application/json

dateCreatedstring · date-timeRequired

idinteger · int64Required

namestringRequired

packageTypestring · enumRequiredPossible values:

versionstringRequired

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/api/v1/catalog/{tagOrId}/packages/python/requirements

POST /api/v1/catalog/{tagOrId}/packages/python/requirements HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

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

Only exact version specifiers (==) are supported in requirements.txt files. Other version specifiers such as >=, <=, ~=, and != are ignored when parsing the file. Packages specified without an exact version will be ingested without a version value.

[python] Delete Python package

delete

Authorizations

AuthorizationstringRequired

All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.

Path parameters

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Query parameters

namestringRequired

Responses

200

Successfully deleted package

No content

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/api/v1/catalog/{tagOrId}/packages/python

DELETE /api/v1/catalog/{tagOrId}/packages/python?name=text HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content