Registries

https://api.spectrocloud.com/v1/registries/helm

summary:
Retrieves a list of Helm registries
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters 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.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit is a maximum number of responses to return for a list call. 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.no
continuestringcontinue token for the datasetno
Path parameters:
NameTypeDescriptionRequired
scopestringno
200
An array of registry items
{
"items": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string",
"name": "string"
},
"status": {
"helmSyncStatus": {
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}
}
}
],
"listmeta": {
"continue": "string",
"count": "integer"
}
}

https://api.spectrocloud.com/v1/registries/helm

summary:
Creates a helm registry
Path parameters:
NameTypeDescriptionRequired
scopestringno
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"createOption": {
"charts": [
{
"name": "string",
"version": "string"
}
],
"skipSync": "boolean"
},
"endpoint": "string",
"name": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/registries/helm/summary

summary:
Retrieves a list of helm registries as summary
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters 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.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit is a maximum number of responses to return for a list call. 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.no
continuestringcontinue token for the datasetno
Path parameters:
NameTypeDescriptionRequired
scopestringno
200
An array of registry items
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"endpoint": "string"
},
"status": {
"sync": {
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}
}
}
],
"listmeta": {
"continue": "string",
"count": "integer"
}
}

https://api.spectrocloud.com/v1/registries/helm/validate

summary:
Check if helm registry is valid
description:
Returns no contents if helm registry is valid else error.
{
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string",
"name": "string"
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/registries/helm/{uid}

summary:
Returns the specified Helm registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string",
"name": "string"
},
"status": {
"helmSyncStatus": {
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}
}
}

https://api.spectrocloud.com/v1/registries/helm/{uid}

summary:
Updates the specified helm registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string",
"name": "string"
},
"status": {
"helmSyncStatus": {
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/registries/helm/{uid}

summary:
Deletes the specified helm registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/registries/helm/{uid}/sync

summary:
Sync Helm registry
description:
Sync all the helm charts from the registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
202
Ok reponse without content

https://api.spectrocloud.com/v1/registries/helm/{uid}/sync/status

summary:
Get helm registry sync status
description:
Get the sync status for the specified helm registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
Helm registry sync status
{
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}

https://api.spectrocloud.com/v1/registries/oci/basic

summary:
Creates a basic oci registry
{
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/registries/oci/ecr

summary:
Creates a ecr registry
{
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"credentials": {
"accessKey": "string",
"credentialType": "string",
"secretKey": "string",
"sts": {
"arn": "string",
"externalId": "string"
}
},
"endpoint": "string",
"isPrivate": "boolean"
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/registries/oci/summary

summary:
Retrieves a oci registries summary
200
An array of oci registry items
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"endpoint": "string",
"isPrivate": "boolean",
"registryType": "string"
}
}
]
}

https://api.spectrocloud.com/v1/registries/oci/{uid}

summary:
Returns the information of specified oci registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string",
"type": "string"
}

https://api.spectrocloud.com/v1/registries/oci/{uid}/basic

summary:
Returns the basic oci registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string"
}
}

https://api.spectrocloud.com/v1/registries/oci/{uid}/basic

summary:
Updates the specified basic oci registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/registries/oci/{uid}/basic

summary:
Deletes the specified basic oci registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/registries/oci/{uid}/ecr

summary:
Returns the specified ecr registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"credentials": {
"accessKey": "string",
"credentialType": "string",
"secretKey": "string",
"sts": {
"arn": "string",
"externalId": "string"
}
},
"endpoint": "string",
"isPrivate": "boolean"
}
}

https://api.spectrocloud.com/v1/registries/oci/{uid}/ecr

summary:
Updates the specified ecr registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"credentials": {
"accessKey": "string",
"credentialType": "string",
"secretKey": "string",
"sts": {
"arn": "string",
"externalId": "string"
}
},
"endpoint": "string",
"isPrivate": "boolean"
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/registries/oci/{uid}/ecr

summary:
Deletes the specified ecr registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/registries/pack

summary:
Retrieves a list of Pack registries
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters 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.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit is a maximum number of responses to return for a list call. 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.no
continuestringcontinue token for the datasetno
Path parameters:
NameTypeDescriptionRequired
scopestringno
200
An array of registry items
{
"items": [
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string",
"name": "string",
"private": "boolean"
},
"status": {
"packSyncStatus": {
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}
}
}
],
"listmeta": {
"continue": "string",
"count": "integer"
}
}

https://api.spectrocloud.com/v1/registries/pack

summary:
Creates a pack registry
Parameters:
NameTypeDescriptionRequired
skipPackSyncbooleanno
Path parameters:
NameTypeDescriptionRequired
scopestringno
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string",
"name": "string",
"private": "boolean"
},
"status": {
"packSyncStatus": {
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}
}
}
201
Created successfully
{
"uid": "string"
}

https://api.spectrocloud.com/v1/registries/pack/summary

summary:
Retrieves a list of pack registries as summary
Parameters:
NameTypeDescriptionRequired
fieldsstringSet of fields to be presented in the response with values. The fields are comma separated. Eg: metadata.uid,metadata.nameno
filtersstringFilters 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.no
orderBystringSpecify the fields with sort order. 1 indicates ascending and -1 for descending. Eg: orderBy=metadata.name=1,metadata.uid=-1no
limitintegerlimit is a maximum number of responses to return for a list call. 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.no
continuestringcontinue token for the datasetno
Path parameters:
NameTypeDescriptionRequired
scopestringno
200
An array of registry items
{
"items": [
{
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"endpoint": "string",
"private": "boolean"
},
"status": {
"sync": {
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}
}
}
],
"listmeta": {
"continue": "string",
"count": "integer"
}
}

https://api.spectrocloud.com/v1/registries/pack/validate

summary:
Check if pack registry is valid
description:
Returns no contents if pack registry is valid else error.
{
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string",
"name": "string",
"private": "boolean"
}
204
Ok reponse without content

https://api.spectrocloud.com/v1/registries/pack/{uid}

summary:
Returns the specified Pack registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
OK
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string",
"name": "string",
"private": "boolean"
},
"status": {
"packSyncStatus": {
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}
}
}

https://api.spectrocloud.com/v1/registries/pack/{uid}

summary:
Updates the specified pack registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"annotations": "object",
"creationTimestamp": "date-time",
"deletionTimestamp": "date-time",
"labels": "object",
"name": "string",
"namespace": "string",
"resourceVersion": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"auth": {
"password": "string",
"token": "string",
"type": "string",
"username": "string"
},
"endpoint": "string",
"name": "string",
"private": "boolean"
},
"status": {
"packSyncStatus": {
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}
}
}
204
The resource was updated successfully

https://api.spectrocloud.com/v1/registries/pack/{uid}

summary:
Deletes the specified pack registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
204
The resource was deleted successfully

https://api.spectrocloud.com/v1/registries/pack/{uid}/sync

summary:
Sync Pack registry
description:
Sync all the packs from the registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
202
Ok reponse without content

https://api.spectrocloud.com/v1/registries/pack/{uid}/sync/status

summary:
Get pack registry sync status
description:
Get sync status for the pack specified registry
Path parameters:
NameTypeDescriptionRequired
uidstringyes
200
Pack registry sync status
{
"lastRunTime": "date-time",
"lastSyncedTime": "date-time",
"message": "string",
"status": "string"
}