GitHub
DevOps Service
Backend service & agents
24
DevOps UI
Dashboard & frontend
1

Catalogs endpoints

This document contains the endpoints for the Catalogs category.

Gets all the remote catalogs

/api/v1/catalog Authorized

This endpoint returns all the remote catalogs

Gets all the remote catalogs

/api/v1/catalog/{catalogId} Authorized

This endpoint returns all the remote catalogs

Parameters
Name Type In Required Description
catalogId string path required Catalog ID

Gets a catalog manifest version

/api/v1/catalog/{catalogId}/{version} Authorized

This endpoint returns a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version

Gets a catalog manifest version architecture

/api/v1/catalog/{catalogId}/{version}/{architecture} Authorized

This endpoint returns a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture

Downloads a catalog manifest version

/api/v1/catalog/{catalogId}/{version}/{architecture}/download Authorized

This endpoint downloads a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture

Taints a catalog manifest version

/api/v1/catalog/{catalogId}/{version}/{architecture}/taint Authorized

This endpoint Taints a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture

UnTaints a catalog manifest version

/api/v1/catalog/{catalogId}/{version}/{architecture}/untaint Authorized

This endpoint UnTaints a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture

UnTaints a catalog manifest version

/api/v1/catalog/{catalogId}/{version}/{architecture}/revoke Authorized

This endpoint UnTaints a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture

Adds claims to a catalog manifest version

/api/v1/catalog/{catalogId}/{version}/{architecture}/claims Authorized

This endpoint adds claims to a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture
request object body optional Body
Schema 
{
  "connection": "string",
  "required_claims": "[]string",
  "required_roles": "[]string",
  "tags": "[]string"
}

Removes claims from a catalog manifest version

/api/v1/catalog/{catalogId}/{version}/{architecture}/claims Authorized

This endpoint removes claims from a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture
request object body optional Body
Schema 
{
  "connection": "string",
  "required_claims": "[]string",
  "required_roles": "[]string",
  "tags": "[]string"
}

Adds roles to a catalog manifest version

/api/v1/catalog/{catalogId}/{version}/{architecture}/roles Authorized

This endpoint adds roles to a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture
request object body optional Body
Schema 
{
  "connection": "string",
  "required_claims": "[]string",
  "required_roles": "[]string",
  "tags": "[]string"
}

Removes roles from a catalog manifest version

/api/v1/catalog/{catalogId}/{version}/{architecture}/roles Authorized

This endpoint removes roles from a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture
request object body optional Body
Schema 
{
  "connection": "string",
  "required_claims": "[]string",
  "required_roles": "[]string",
  "tags": "[]string"
}

Adds tags to a catalog manifest version

/api/v1/catalog/{catalogId}/{version}/{architecture}/tags Authorized

This endpoint adds tags to a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture
request object body optional Body
Schema 
{
  "connection": "string",
  "required_claims": "[]string",
  "required_roles": "[]string",
  "tags": "[]string"
}

Removes tags from a catalog manifest version

/api/v1/catalog/{catalogId}/{version}/{architecture}/tags Authorized

This endpoint removes tags from a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture
request object body optional Body
Schema 
{
  "connection": "string",
  "required_claims": "[]string",
  "required_roles": "[]string",
  "tags": "[]string"
}

Deletes a catalog manifest and all its versions

/api/v1/catalog/{catalogId} Authorized

This endpoint deletes a catalog manifest and all its versions

Parameters
Name Type In Required Description
catalogId string path required Catalog ID

Deletes a catalog manifest version

/api/v1/catalog/{catalogId}/{version} Authorized

This endpoint deletes a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version

Deletes a catalog manifest version architecture

/api/v1/catalog/{catalogId}/{version}/{architecture} Authorized

This endpoint deletes a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version
architecture string path required Architecture

Pushes a catalog manifest to the catalog inventory

/api/v1/catalog/push Authorized

This endpoint pushes a catalog manifest to the catalog inventory

Parameters
Name Type In Required Description
pushRequest object body optional Push request
Schema 
{
  "architecture": "string",
  "catalog_id": "string",
  "compress_pack": "bool",
  "compress_pack_level": "int",
  "connection": "string",
  "description": "string",
  "local_path": "string",
  "minimum_requirements": {
    "cpu": "int",
    "disk": "int",
    "memory": "int"
  },
  "pack_size": "int64",
  "required_claims": "[]string",
  "required_roles": "[]string",
  "tags": "[]string",
  "uuid": "string",
  "version": "string"
}

Pull a remote catalog manifest

/api/v1/catalog/pull Authorized

This endpoint pulls a remote catalog manifest

Parameters
Name Type In Required Description
pullRequest object body optional Pull request
Schema 
{
  "architecture": "string",
  "catalog_id": "string",
  "client": "string",
  "connection": "string",
  "machine_name": "string",
  "owner": "string",
  "path": "string",
  "provider_metadata": "map[string]string",
  "start_after_pull": "bool",
  "version": "string"
}

Imports a remote catalog manifest metadata into the catalog inventory

/api/v1/catalog/import Authorized

This endpoint imports a remote catalog manifest metadata into the catalog inventory

Parameters
Name Type In Required Description
importRequest object body optional Pull request
Schema 
{
  "architecture": "string",
  "catalog_id": "string",
  "connection": "string",
  "provider_metadata": "map[string]string",
  "version": "string"
}

Imports a vm into the catalog inventory generating the metadata for it

/api/v1/catalog/import-vm Authorized

This endpoint imports a virtual machine in pvm or macvm format into the catalog inventory generating the metadata for it

Parameters
Name Type In Required Description
importRequest object body optional Vm Impoty request
Schema 
{
  "architecture": "string",
  "catalog_id": "string",
  "connection": "string",
  "description": "string",
  "force": "bool",
  "is_compressed": "bool",
  "machine_remote_path": "string",
  "provider_metadata": "map[string]string",
  "required_claims": "[]string",
  "required_roles": "[]string",
  "size": "int64",
  "tags": "[]string",
  "type": "string",
  "version": "string"
}

Updates a catalog

/api/v1/catalog/{catalogId}/{version}/{architecture}/claims Authorized

This endpoint adds claims to a catalog manifest version

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
request object body optional Body
Schema 
{
  "connection": "string",
  "required_claims": "[]string",
  "required_roles": "[]string",
  "tags": "[]string"
}

Gets catalog cache

/api/v1/catalog/cache Authorized

This endpoint returns all the remote catalog cache if any

Deletes all catalog cache

/api/v1/catalog/cache Authorized

This endpoint returns all the remote catalog cache if any

Parameters
Name Type In Required Description
catalogId string path required Catalog ID

Deletes catalog cache item and all its versions

/api/v1/catalog/cache/{catalogId} Authorized

This endpoint returns all the remote catalog cache if any and all its versions

Parameters
Name Type In Required Description
catalogId string path required Catalog ID

Deletes catalog cache version item

/api/v1/catalog/cache/{catalogId}/{version} Authorized

This endpoint deletes a version of a cache ite,

Parameters
Name Type In Required Description
catalogId string path required Catalog ID
version string path required Version