Update private Helm repository

curl --request PUT \
  --url https://{apiHost}/api/v1/cluster/instances/kubernetes/helm/repository/id/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "<string>",
    "title": "<string>",
    "description": "<string>",
    "tags": {}
  },
  "spec": {
    "repoDetails": {
      "type": "PRIVATE_REPO_TYPE_UNSPECIFIED",
      "url": "<string>",
      "branch": "<string>"
    },
    "auth": {
      "secret": {
        "type": "SECRET_TYPE_UNSPECIFIED",
        "name": "<string>"
      }
    }
  }
}
'

import requests

url = "https://{apiHost}/api/v1/cluster/instances/kubernetes/helm/repository/id/{id}"

payload = {
    "metadata": {
        "name": "<string>",
        "title": "<string>",
        "description": "<string>",
        "tags": {}
    },
    "spec": {
        "repoDetails": {
            "type": "PRIVATE_REPO_TYPE_UNSPECIFIED",
            "url": "<string>",
            "branch": "<string>"
        },
        "auth": { "secret": {
                "type": "SECRET_TYPE_UNSPECIFIED",
                "name": "<string>"
            } }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {name: '<string>', title: '<string>', description: '<string>', tags: {}},
    spec: {
      repoDetails: {type: 'PRIVATE_REPO_TYPE_UNSPECIFIED', url: '<string>', branch: '<string>'},
      auth: {secret: {type: 'SECRET_TYPE_UNSPECIFIED', name: '<string>'}}
    }
  })
};

fetch('https://{apiHost}/api/v1/cluster/instances/kubernetes/helm/repository/id/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authentication · API availability · Download OpenAPI

This operation can change resources or access. After signing in, open API request settings and select Enable modifying requests, then Apply settings, to use its playground. Check the request body and destination before selecting Send. Your existing API permissions still apply.

Authorizations

Authorization

string

header

required

Bearer token for the ZedCloud gateway user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Path Parameters

string

required

Unique identifier of the private repository to update (required)

Body

application/json

Request message for updating an existing private repository configuration

metadata

Private Repository metadata · object

required

Metadata for the private repository (name cannot be updated, required)

Show child attributes

spec

Private Repository specification · object

required

Specification for the private repository (required)

Show child attributes

Response

Successfully updated private repository configuration

operationType

enum<string>

default:OPS_TYPE_UNSPECIFIED

Available options:

OPS_TYPE_UNSPECIFIED,

OPS_TYPE_READ,

OPS_TYPE_DELETE,

OPS_TYPE_CREATE,

OPS_TYPE_UPDATE,

OPS_TYPE_LIST

operationStatus

enum<string>

default:OPS_STATUS_UNSPECIFIED

OPS_STATUS_PENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING
OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING.
OPS_STATUS_COMPLETE: Even if the result of the operations may result in failure, but the OpsStatus will marked COMPLETE for almost all cases.

Available options:

OPS_STATUS_UNSPECIFIED,

OPS_STATUS_PENDING,

OPS_STATUS_ONGOING,

OPS_STATUS_COMPLETE

objectKind

string

objectId

string

objectName

string

objectRevision

string

objectType

enum<string>

default:OBJECT_TYPE_UNSPECIFIED

Available options:

OBJECT_TYPE_UNSPECIFIED,

OBJECT_TYPE_USER,

OBJECT_TYPE_EDGE_NODE,

OBJECT_TYPE_EDGE_APP,

OBJECT_TYPE_IMAGE,

OBJECT_TYPE_EDGE_APP_INSTANCE,

OBJECT_TYPE_PROJECT,

OBJECT_TYPE_NETWORK,

OBJECT_TYPE_DATASTORE,

OBJECT_TYPE_SERVICE,

OBJECT_TYPE_SERVICE_INSTANCE,

OBJECT_TYPE_ENTERPRISE,

OBJECT_TYPE_ROLE,

OBJECT_TYPE_CREDENTIAL,

OBJECT_TYPE_NETWORK_INSTANCE,

OBJECT_TYPE_VOLUME_INSTANCE,

OBJECT_TYPE_REALM,

OBJECT_TYPE_AUTHPROFILE,

OBJECT_TYPE_POLICY,

OBJECT_TYPE_APP_POLICY,

OBJECT_TYPE_CLUSTER_INSTANCE,

OBJECT_TYPE_PLUGIN,

OBJECT_TYPE_DOC_POLICY,

OBJECT_TYPE_ORCHESTRATOR_CLUSTER,

OBJECT_TYPE_TAGS,

OBJECT_TYPE_EDGE_NODE_INTERFACE,

OBJECT_TYPE_DEPLOYMENT,

OBJECT_TYPE_ENTITLEMENTS,

OBJECT_TYPE_DATA_STREAM,

OBJECT_TYPE_API_USAGE,

OBJECT_TYPE_APP_INSTANCE_SNAPSHOT,

OBJECT_TYPE_PATCH_ENVELOPE,

OBJECT_TYPE_RESOURCE_USAGE_TRACK,

OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE,

OBJECT_TYPE_DEV_PASSTHROUGH,

OBJECT_TYPE_EDGE_NODE_CLUSTER,

OBJECT_TYPE_ASSET_GROUP,

OBJECT_TYPE_APP_PROFILE,

OBJECT_TYPE_PROFILE_DEPLOYMENT,

OBJECT_TYPE_ZKS_INSTANCE,

OBJECT_TYPE_CLUSTER_GROUP

operationTime

string

startTime

string

endTime

string

user

string

httpStatusCode

integer<int32>

httpStatusMsg

string

jobId

string

error

one or more errors will be set if the operation failed i.e. httpStatusCode != 2xx · object[]

Show child attributes

⌘I

Update private Helm repository

curl --request PUT \
  --url https://{apiHost}/api/v1/cluster/instances/kubernetes/helm/repository/id/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "<string>",
    "title": "<string>",
    "description": "<string>",
    "tags": {}
  },
  "spec": {
    "repoDetails": {
      "type": "PRIVATE_REPO_TYPE_UNSPECIFIED",
      "url": "<string>",
      "branch": "<string>"
    },
    "auth": {
      "secret": {
        "type": "SECRET_TYPE_UNSPECIFIED",
        "name": "<string>"
      }
    }
  }
}
'

import requests

url = "https://{apiHost}/api/v1/cluster/instances/kubernetes/helm/repository/id/{id}"

payload = {
    "metadata": {
        "name": "<string>",
        "title": "<string>",
        "description": "<string>",
        "tags": {}
    },
    "spec": {
        "repoDetails": {
            "type": "PRIVATE_REPO_TYPE_UNSPECIFIED",
            "url": "<string>",
            "branch": "<string>"
        },
        "auth": { "secret": {
                "type": "SECRET_TYPE_UNSPECIFIED",
                "name": "<string>"
            } }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    metadata: {name: '<string>', title: '<string>', description: '<string>', tags: {}},
    spec: {
      repoDetails: {type: 'PRIVATE_REPO_TYPE_UNSPECIFIED', url: '<string>', branch: '<string>'},
      auth: {secret: {type: 'SECRET_TYPE_UNSPECIFIED', name: '<string>'}}
    }
  })
};

fetch('https://{apiHost}/api/v1/cluster/instances/kubernetes/helm/repository/id/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

API guides

API services

Update private Helm repository

Authorizations

Headers

Path Parameters

Body

Response