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

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

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

[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

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

Body
stringOptional
Responses
200

Successfully saved packages

application/json
post
/api/v1/catalog/{tagOrId}/packages/dotnet/nuget/csproj

[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

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

Body
stringOptional
Responses
200

Successfully saved packages

application/json
post
/api/v1/catalog/{tagOrId}/packages/dotnet/nuget/packages-lock

[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

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

Query parameters
namestringRequired
Responses
200

Successfully deleted package

No content

delete
/api/v1/catalog/{tagOrId}/packages/dotnet/nuget

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

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

Body
stringOptional
Responses
200

Successfully saved packages

application/json
post
/api/v1/catalog/{tagOrId}/packages/go/gosum

[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

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

Query parameters
namestringRequired
Responses
200

Successfully deleted package

No content

delete
/api/v1/catalog/{tagOrId}/packages/go

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

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

[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

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

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

[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

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

Body
stringOptional
Responses
200

Successfully saved packages

application/json
post
/api/v1/catalog/{tagOrId}/packages/java/maven-pom

[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

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

Query parameters
namestringRequired
Responses
200

Successfully deleted package

No content

delete
/api/v1/catalog/{tagOrId}/packages/java

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

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

Body
stringOptional
Responses
200

Successfully saved packages

application/json
post
/api/v1/catalog/{tagOrId}/packages/node/package-json

[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

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

Body
stringOptional
Responses
200

Successfully saved packages

application/json
post
/api/v1/catalog/{tagOrId}/packages/node/package-lock

[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

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

Query parameters
namestringRequired
Responses
200

Successfully deleted package

No content

delete
/api/v1/catalog/{tagOrId}/packages/node

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

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

Body
stringOptional
Responses
200

Successfully saved packages

application/json
post
/api/v1/catalog/{tagOrId}/packages/node/pnpm-lock

[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

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

Body
stringOptional
Responses
200

Successfully saved packages

application/json
post
/api/v1/catalog/{tagOrId}/packages/node/yarn-lock

[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

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

Body
stringOptional
Responses
200

Successfully saved packages

application/json
post
/api/v1/catalog/{tagOrId}/packages/python/pipfile

[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

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

Body
stringOptional
Responses
200

Successfully saved packages

application/json
post
/api/v1/catalog/{tagOrId}/packages/python/requirements

[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

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

Query parameters
namestringRequired
Responses
200

Successfully deleted package

No content

delete
/api/v1/catalog/{tagOrId}/packages/python

No content

Was this helpful?