Spectro Cloud registries API
The registries API from Spectro Cloud — 28 operation(s) for registries.
The registries API from Spectro Cloud — 28 operation(s) for registries.
swagger: '2.0'
info:
title: Local Management APIs activations registries API
version: v1
servers:
- url: https://edge-host-ip:5080
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: registries
x-displayName: Registries
paths:
/v1/registries/helm:
parameters:
- default: all
enum:
- system
- tenant
- all
in: query
name: scope
type: string
get:
operationId: v1RegistriesHelmList
parameters:
- description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
in: query
name: fields
type: string
- description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws
Server will be restricted to certain fields based on the indexed data for each resource.'
in: query
name: filters
type: string
- description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
in: query
name: orderBy
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of registry items
schema:
$ref: '#/definitions/v1HelmRegistries'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of Helm registries
tags:
- registries
post:
operationId: v1RegistriesHelmCreate
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1HelmRegistryEntity'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'201':
description: Created successfully
headers:
AuditUid:
description: Audit uid for the request
type: string
schema:
$ref: '#/definitions/v1Uid'
security:
- ApiKey: []
- Authorization: []
summary: Creates a helm registry
tags:
- registries
/v1/registries/helm/summary:
parameters:
- default: all
enum:
- system
- tenant
- all
in: query
name: scope
type: string
get:
operationId: v1RegistriesHelmSummaryList
parameters:
- description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
in: query
name: fields
type: string
- description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws
Server will be restricted to certain fields based on the indexed data for each resource.'
in: query
name: filters
type: string
- description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
in: query
name: orderBy
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of registry items
schema:
$ref: '#/definitions/v1HelmRegistriesSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of helm registries as summary
tags:
- registries
/v1/registries/helm/validate:
post:
description: Returns no contents if helm registry is valid else error.
operationId: V1RegistriesHelmValidate
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/v1HelmRegistrySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Check if helm registry is valid
tags:
- registries
/v1/registries/helm/{uid}:
parameters:
- in: path
name: uid
required: true
type: string
delete:
operationId: v1RegistriesHelmUidDelete
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: The resource was deleted successfully
security:
- ApiKey: []
- Authorization: []
summary: Deletes the specified helm registry
tags:
- registries
get:
operationId: v1RegistriesHelmUidGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/v1HelmRegistry'
security:
- ApiKey: []
- Authorization: []
summary: Returns the specified Helm registry
tags:
- registries
put:
operationId: v1RegistriesHelmUidUpdate
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1HelmRegistry'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: The resource was updated successfully
security:
- ApiKey: []
- Authorization: []
summary: Updates the specified helm registry
tags:
- registries
/v1/registries/helm/{uid}/sync:
parameters:
- in: path
name: uid
required: true
type: string
- default: false
in: query
name: forceSync
type: boolean
post:
description: Sync all the helm charts from the registry
operationId: v1RegistriesHelmUidSync
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'202':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Sync Helm registry
tags:
- registries
/v1/registries/helm/{uid}/sync/status:
parameters:
- in: path
name: uid
required: true
type: string
get:
description: Get the sync status for the specified helm registry
operationId: v1RegistriesHelmUidSyncStatus
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: Helm registry sync status
schema:
$ref: '#/definitions/v1RegistrySyncStatus'
security:
- ApiKey: []
- Authorization: []
summary: Get helm registry sync status
tags:
- registries
/v1/registries/metadata:
parameters:
- default: all
enum:
- system
- tenant
- all
in: query
name: scope
type: string
get:
operationId: v1RegistriesMetadata
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of registry metadata items
schema:
$ref: '#/definitions/v1RegistriesMetadata'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of registries metadata
tags:
- registries
/v1/registries/oci/basic:
post:
operationId: v1BasicOciRegistriesCreate
parameters:
- default: false
in: query
name: skipPackSync
type: boolean
- in: body
name: body
schema:
$ref: '#/definitions/v1BasicOciRegistry'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'201':
description: Created successfully
headers:
AuditUid:
description: Audit uid for the request
type: string
schema:
$ref: '#/definitions/v1Uid'
security:
- ApiKey: []
- Authorization: []
summary: Creates a basic oci registry
tags:
- registries
/v1/registries/oci/basic/validate:
post:
description: Returns no contents if oci registry is valid else error.
operationId: v1BasicOciRegistriesValidate
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/v1BasicOciRegistrySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Check if oci registry is valid
tags:
- registries
/v1/registries/oci/ecr:
post:
operationId: v1EcrRegistriesCreate
parameters:
- default: false
in: query
name: skipPackSync
type: boolean
- in: body
name: body
schema:
$ref: '#/definitions/v1EcrRegistry'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'201':
description: Created successfully
headers:
AuditUid:
description: Audit uid for the request
type: string
schema:
$ref: '#/definitions/v1Uid'
security:
- ApiKey: []
- Authorization: []
summary: Creates a ecr registry
tags:
- registries
/v1/registries/oci/ecr/validate:
post:
description: Returns no contents if ecr registry is valid else error.
operationId: v1EcrRegistriesValidate
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/v1EcrRegistrySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Check if ecr registry is valid
tags:
- registries
/v1/registries/oci/image:
get:
operationId: v1OciImageRegistryGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: (empty)
schema:
$ref: '#/definitions/v1OciImageRegistry'
security:
- ApiKey: []
- Authorization: []
summary: Creates a image registry
tags:
- registries
/v1/registries/oci/summary:
get:
operationId: v1OciRegistriesSummary
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of oci registry items
schema:
$ref: '#/definitions/v1OciRegistries'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a oci registries summary
tags:
- registries
/v1/registries/oci/{uid}:
parameters:
- in: path
name: uid
required: true
type: string
- in: query
name: clusterUid
type: string
get:
operationId: v1OciRegistriesGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/v1OciRegistryEntity'
security:
- ApiKey: []
- Authorization: []
summary: Returns the information of specified oci registry
tags:
- registries
/v1/registries/oci/{uid}/basic:
parameters:
- in: path
name: uid
required: true
type: string
delete:
operationId: v1BasicOciRegistriesUidDelete
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: The resource was deleted successfully
security:
- ApiKey: []
- Authorization: []
summary: Deletes the specified basic oci registry
tags:
- registries
get:
operationId: v1BasicOciRegistriesUidGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/v1BasicOciRegistry'
security:
- ApiKey: []
- Authorization: []
summary: Returns the basic oci registry
tags:
- registries
put:
operationId: v1BasicOciRegistriesUidUpdate
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1BasicOciRegistry'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: The resource was updated successfully
security:
- ApiKey: []
- Authorization: []
summary: Updates the specified basic oci registry
tags:
- registries
/v1/registries/oci/{uid}/basic/sync:
parameters:
- in: path
name: uid
required: true
type: string
- default: false
in: query
name: forceSync
type: boolean
post:
description: Sync all the content from the oci registry
operationId: v1BasicOciRegistriesUidSync
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'202':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Sync oci registry
tags:
- registries
/v1/registries/oci/{uid}/basic/sync/status:
parameters:
- in: path
name: uid
required: true
type: string
get:
description: Get sync status for the oci specified registry
operationId: v1BasicOciRegistriesUidSyncStatus
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: Oci registry sync status
schema:
$ref: '#/definitions/v1RegistrySyncStatus'
security:
- ApiKey: []
- Authorization: []
summary: Get oci registry sync status
tags:
- registries
/v1/registries/oci/{uid}/ecr:
parameters:
- in: path
name: uid
required: true
type: string
delete:
operationId: v1EcrRegistriesUidDelete
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: The resource was deleted successfully
security:
- ApiKey: []
- Authorization: []
summary: Deletes the specified ecr registry
tags:
- registries
get:
operationId: v1EcrRegistriesUidGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/v1EcrRegistry'
security:
- ApiKey: []
- Authorization: []
summary: Returns the specified ecr registry
tags:
- registries
put:
operationId: v1EcrRegistriesUidUpdate
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1EcrRegistry'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: The resource was updated successfully
security:
- ApiKey: []
- Authorization: []
summary: Updates the specified ecr registry
tags:
- registries
/v1/registries/oci/{uid}/ecr/sync:
parameters:
- in: path
name: uid
required: true
type: string
- default: false
in: query
name: forceSync
type: boolean
post:
description: Sync all the content from the ecr registry
operationId: v1EcrRegistriesUidSync
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'202':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Sync ecr registry
tags:
- registries
/v1/registries/oci/{uid}/ecr/sync/status:
parameters:
- in: path
name: uid
required: true
type: string
get:
description: Get sync status for the ecr specified registry
operationId: v1EcrRegistriesUidSyncStatus
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: Ecr registry sync status
schema:
$ref: '#/definitions/v1RegistrySyncStatus'
security:
- ApiKey: []
- Authorization: []
summary: Get ecr registry sync status
tags:
- registries
/v1/registries/pack:
parameters:
- default: all
enum:
- system
- tenant
- all
in: query
name: scope
type: string
get:
operationId: v1RegistriesPackList
parameters:
- description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
in: query
name: fields
type: string
- description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws
Server will be restricted to certain fields based on the indexed data for each resource.'
in: query
name: filters
type: string
- description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
in: query
name: orderBy
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of registry items
schema:
$ref: '#/definitions/v1PackRegistries'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of Pack registries
tags:
- registries
post:
operationId: v1RegistriesPackCreate
parameters:
- default: false
in: query
name: skipPackSync
type: boolean
- in: body
name: body
schema:
$ref: '#/definitions/v1PackRegistry'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'201':
description: Created successfully
headers:
AuditUid:
description: Audit uid for the request
type: string
schema:
$ref: '#/definitions/v1Uid'
security:
- ApiKey: []
- Authorization: []
summary: Creates a pack registry
tags:
- registries
/v1/registries/pack/summary:
parameters:
- default: all
enum:
- system
- tenant
- all
in: query
name: scope
type: string
get:
operationId: v1RegistriesPackSummaryList
parameters:
- description: 'Set of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.name'
in: query
name: fields
type: string
- description: 'Filters can be combined with AND, OR operators with field path name. Eg: metadata.name=TestServiceANDspec.cloudType=aws
Server will be restricted to certain fields based on the indexed data for each resource.'
in: query
name: filters
type: string
- description: 'Specify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1'
in: query
name: orderBy
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of registry items
schema:
$ref: '#/definitions/v1PackRegistriesSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of pack registries as summary
tags:
- registries
/v1/registries/pack/validate:
post:
description: Returns no contents if pack registry is valid else error.
operationId: V1RegistriesPackValidate
parameters:
- in: body
name: body
required: true
schema:
$ref: '#/definitions/v1PackRegistrySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Check if pack registry is valid
tags:
- registries
/v1/registries/pack/{uid}:
parameters:
- in: path
name: uid
required: true
type: string
delete:
operationId: v1RegistriesPackUidDelete
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: The resource was deleted successfully
security:
- ApiKey: []
- Authorization: []
summary: Deletes the specified pack registry
tags:
- registries
get:
operationId: v1RegistriesPackUidGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/v1PackRegistry'
security:
- ApiKey: []
- Authorization: []
summary: Returns the specified Pack registry
tags:
- registries
put:
operationId: v1RegistriesPackUidUpdate
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1PackRegistry'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'204':
description: The resource was updated successfully
security:
- ApiKey: []
- Authorization: []
summary: Updates the specified pack registry
tags:
- registries
/v1/registries/pack/{uid}/sync:
parameters:
- in: path
name: uid
required: true
type: string
- default: false
in: query
name: forceSync
type: boolean
post:
description: Sync all the packs from the registry
operationId: v1RegistriesPackUidSync
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'202':
description: Ok response without content
headers:
AuditUid:
description: Audit uid for the request
type: string
security:
- ApiKey: []
- Authorization: []
summary: Sync Pack registry
tags:
- registries
/v1/registries/pack/{uid}/sync/status:
parameters:
- in: path
name: uid
required: true
type: string
get:
description: Get sync status for the pack specified registry
operationId: v1RegistriesPackUidSyncStatus
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: Pack registry sync status
schema:
$ref: '#/definitions/v1RegistrySyncStatus'
security:
- ApiKey: []
- Authorization: []
summary: Get pack registry sync status
tags:
- registries
/v1/registries/{registryName}/config:
parameters:
- in: path
name: registryName
required: true
type: string
get:
operationId: v1RegistriesNameConfigGet
parameters:
- description: A project UID is required for project-scoped resources and s
# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/openapi/spectro-cloud-registries-api-openapi.yml