Skip to main content
POST
/
api
/
v1
/
org
/
helm
/
registries
Create Helm Registry Endpoint
import requests

url = "https://platform.ankra.app/api/v1/org/helm/registries"

payload = { "spec": {
        "bitbucket_cloud_accessible_repositories_scraper": { "credential_name": "<string>" },
        "bitbucket_cloud_credential": {
            "access_token": "<string>",
            "account_login": "<string>",
            "account_type": "<string>",
            "name": "<string>",
            "expires_at": "<string>",
            "refresh_token": "<string>"
        },
        "bitbucket_cloud_repositories": [
            {
                "credential_name": "<string>",
                "default_branch": "<string>",
                "git_url": "<string>",
                "name": "<string>",
                "private": True,
                "slug": "<string>",
                "web_url": "<string>",
                "workspace": "<string>"
            }
        ],
        "bitbucket_cloud_user_credential": {
            "access_token": "<string>",
            "account_login": "<string>",
            "account_type": "<string>",
            "ankra_user_id": "<string>",
            "name": "<string>",
            "expires_at": "<string>",
            "refresh_token": "<string>"
        },
        "bitbucket_cloud_webhook": {
            "credential_name": "<string>",
            "repo_slug": "<string>",
            "workspace": "<string>"
        },
        "bitbucket_dc_accessible_repositories_scraper": {
            "credential_name": "<string>",
            "instance_url": "<string>"
        },
        "bitbucket_dc_credential": {
            "access_token": "<string>",
            "account_login": "<string>",
            "auth_kind": "<string>",
            "instance_url": "<string>",
            "name": "<string>",
            "expires_at": "<string>",
            "refresh_token": "<string>"
        },
        "bitbucket_dc_repositories": [
            {
                "credential_name": "<string>",
                "default_branch": "<string>",
                "git_url": "<string>",
                "instance_url": "<string>",
                "name": "<string>",
                "private": True,
                "project_key": "<string>",
                "slug": "<string>",
                "web_url": "<string>"
            }
        ],
        "bitbucket_dc_user_credential": {
            "access_token": "<string>",
            "account_login": "<string>",
            "ankra_user_id": "<string>",
            "auth_kind": "<string>",
            "instance_url": "<string>",
            "name": "<string>",
            "expires_at": "<string>",
            "refresh_token": "<string>"
        },
        "bitbucket_dc_webhook": {
            "credential_name": "<string>",
            "instance_url": "<string>",
            "project_key": "<string>",
            "repo_slug": "<string>"
        },
        "github_accessible_repositories_scraper": { "credential_name": "<string>" },
        "github_credential": {
            "account_login": "<string>",
            "account_type": "<string>",
            "name": "<string>",
            "access_token": "<string>",
            "expires_at": "<string>",
            "installation_id": 123,
            "refresh_token": "<string>"
        },
        "github_helm_chart_releases": [
            {
                "authors": ["<string>"],
                "body": "<string>",
                "chart_resource_id": "<string>",
                "created_at": "<string>",
                "html_url": "<string>",
                "release_id": "<string>",
                "repository_name": "<string>",
                "repository_owner": "<string>",
                "version": "<string>",
                "prerelease": False
            }
        ],
        "github_repositories": [
            {
                "credential_name": "<string>",
                "default_branch": "<string>",
                "git_url": "<string>",
                "name": "<string>",
                "owner": "<string>",
                "private": True,
                "web_url": "<string>"
            }
        ],
        "github_user_credential": {
            "access_token": "<string>",
            "account_login": "<string>",
            "account_type": "<string>",
            "ankra_user_id": "<string>",
            "name": "<string>"
        },
        "global_github_helm_registry_repository": {
            "registry_directory_path": "<string>",
            "repository_name": "<string>",
            "repository_owner": "<string>",
            "branch": "master"
        },
        "helm_chart": {
            "name": "<string>",
            "registry_name": "<string>",
            "registry_url": "<string>",
            "github_release_scraper": {
                "repository_name": "<string>",
                "repository_owner": "<string>"
            },
            "versions": []
        },
        "helm_http_registry": {
            "name": "<string>",
            "url": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "credential_name": "<string>",
            "delete_permanently": False,
            "exclude_charts": [],
            "updated_at": "2023-11-07T05:31:56Z"
        },
        "helm_oci_registry": {
            "name": "<string>",
            "url": "<string>",
            "created_at": "2023-11-07T05:31:56Z",
            "credential_name": "<string>",
            "delete_permanently": False,
            "updated_at": "2023-11-07T05:31:56Z"
        },
        "helm_registry_credential": {
            "name": "<string>",
            "password": "<string>",
            "username": "<string>"
        },
        "proxmox_cluster": {
            "cluster_name": "<string>",
            "credential": "<string>",
            "network": {
                "cidr": "<string>",
                "name": "<string>",
                "vlan": 123
            },
            "organisation_id": "<string>",
            "vms": [
                {
                    "cpu": 123,
                    "disk_gb": 123,
                    "memory_mb": 123,
                    "name": "<string>"
                }
            ],
            "ankra_agent": {
                "url": "<string>",
                "version": "<string>"
            }
        },
        "proxmox_credentials": [
            {
                "host": "<string>",
                "name": "<string>",
                "port": 123,
                "user": "<string>",
                "bastion": {},
                "password": "<string>",
                "token_name": "<string>",
                "token_value": "<string>"
            }
        ]
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
spec: {
bitbucket_cloud_accessible_repositories_scraper: {credential_name: '<string>'},
bitbucket_cloud_credential: {
access_token: '<string>',
account_login: '<string>',
account_type: '<string>',
name: '<string>',
expires_at: '<string>',
refresh_token: '<string>'
},
bitbucket_cloud_repositories: [
{
credential_name: '<string>',
default_branch: '<string>',
git_url: '<string>',
name: '<string>',
private: true,
slug: '<string>',
web_url: '<string>',
workspace: '<string>'
}
],
bitbucket_cloud_user_credential: {
access_token: '<string>',
account_login: '<string>',
account_type: '<string>',
ankra_user_id: '<string>',
name: '<string>',
expires_at: '<string>',
refresh_token: '<string>'
},
bitbucket_cloud_webhook: {credential_name: '<string>', repo_slug: '<string>', workspace: '<string>'},
bitbucket_dc_accessible_repositories_scraper: {credential_name: '<string>', instance_url: '<string>'},
bitbucket_dc_credential: {
access_token: '<string>',
account_login: '<string>',
auth_kind: '<string>',
instance_url: '<string>',
name: '<string>',
expires_at: '<string>',
refresh_token: '<string>'
},
bitbucket_dc_repositories: [
{
credential_name: '<string>',
default_branch: '<string>',
git_url: '<string>',
instance_url: '<string>',
name: '<string>',
private: true,
project_key: '<string>',
slug: '<string>',
web_url: '<string>'
}
],
bitbucket_dc_user_credential: {
access_token: '<string>',
account_login: '<string>',
ankra_user_id: '<string>',
auth_kind: '<string>',
instance_url: '<string>',
name: '<string>',
expires_at: '<string>',
refresh_token: '<string>'
},
bitbucket_dc_webhook: {
credential_name: '<string>',
instance_url: '<string>',
project_key: '<string>',
repo_slug: '<string>'
},
github_accessible_repositories_scraper: {credential_name: '<string>'},
github_credential: {
account_login: '<string>',
account_type: '<string>',
name: '<string>',
access_token: '<string>',
expires_at: '<string>',
installation_id: 123,
refresh_token: '<string>'
},
github_helm_chart_releases: [
{
authors: ['<string>'],
body: JSON.stringify('<string>'),
chart_resource_id: '<string>',
created_at: '<string>',
html_url: '<string>',
release_id: '<string>',
repository_name: '<string>',
repository_owner: '<string>',
version: '<string>',
prerelease: false
}
],
github_repositories: [
{
credential_name: '<string>',
default_branch: '<string>',
git_url: '<string>',
name: '<string>',
owner: '<string>',
private: true,
web_url: '<string>'
}
],
github_user_credential: {
access_token: '<string>',
account_login: '<string>',
account_type: '<string>',
ankra_user_id: '<string>',
name: '<string>'
},
global_github_helm_registry_repository: {
registry_directory_path: '<string>',
repository_name: '<string>',
repository_owner: '<string>',
branch: 'master'
},
helm_chart: {
name: '<string>',
registry_name: '<string>',
registry_url: '<string>',
github_release_scraper: {repository_name: '<string>', repository_owner: '<string>'},
versions: []
},
helm_http_registry: {
name: '<string>',
url: '<string>',
created_at: '2023-11-07T05:31:56Z',
credential_name: '<string>',
delete_permanently: false,
exclude_charts: [],
updated_at: '2023-11-07T05:31:56Z'
},
helm_oci_registry: {
name: '<string>',
url: '<string>',
created_at: '2023-11-07T05:31:56Z',
credential_name: '<string>',
delete_permanently: false,
updated_at: '2023-11-07T05:31:56Z'
},
helm_registry_credential: {name: '<string>', password: '<string>', username: '<string>'},
proxmox_cluster: {
cluster_name: '<string>',
credential: '<string>',
network: {cidr: '<string>', name: '<string>', vlan: 123},
organisation_id: '<string>',
vms: [{cpu: 123, disk_gb: 123, memory_mb: 123, name: '<string>'}],
ankra_agent: {url: '<string>', version: '<string>'}
},
proxmox_credentials: [
{
host: '<string>',
name: '<string>',
port: 123,
user: '<string>',
bastion: {},
password: '<string>',
token_name: '<string>',
token_value: '<string>'
}
]
}
})
};

fetch('https://platform.ankra.app/api/v1/org/helm/registries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
curl --request POST \
--url https://platform.ankra.app/api/v1/org/helm/registries \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"spec": {
"bitbucket_cloud_accessible_repositories_scraper": {
"credential_name": "<string>"
},
"bitbucket_cloud_credential": {
"access_token": "<string>",
"account_login": "<string>",
"account_type": "<string>",
"name": "<string>",
"expires_at": "<string>",
"refresh_token": "<string>"
},
"bitbucket_cloud_repositories": [
{
"credential_name": "<string>",
"default_branch": "<string>",
"git_url": "<string>",
"name": "<string>",
"private": true,
"slug": "<string>",
"web_url": "<string>",
"workspace": "<string>"
}
],
"bitbucket_cloud_user_credential": {
"access_token": "<string>",
"account_login": "<string>",
"account_type": "<string>",
"ankra_user_id": "<string>",
"name": "<string>",
"expires_at": "<string>",
"refresh_token": "<string>"
},
"bitbucket_cloud_webhook": {
"credential_name": "<string>",
"repo_slug": "<string>",
"workspace": "<string>"
},
"bitbucket_dc_accessible_repositories_scraper": {
"credential_name": "<string>",
"instance_url": "<string>"
},
"bitbucket_dc_credential": {
"access_token": "<string>",
"account_login": "<string>",
"auth_kind": "<string>",
"instance_url": "<string>",
"name": "<string>",
"expires_at": "<string>",
"refresh_token": "<string>"
},
"bitbucket_dc_repositories": [
{
"credential_name": "<string>",
"default_branch": "<string>",
"git_url": "<string>",
"instance_url": "<string>",
"name": "<string>",
"private": true,
"project_key": "<string>",
"slug": "<string>",
"web_url": "<string>"
}
],
"bitbucket_dc_user_credential": {
"access_token": "<string>",
"account_login": "<string>",
"ankra_user_id": "<string>",
"auth_kind": "<string>",
"instance_url": "<string>",
"name": "<string>",
"expires_at": "<string>",
"refresh_token": "<string>"
},
"bitbucket_dc_webhook": {
"credential_name": "<string>",
"instance_url": "<string>",
"project_key": "<string>",
"repo_slug": "<string>"
},
"github_accessible_repositories_scraper": {
"credential_name": "<string>"
},
"github_credential": {
"account_login": "<string>",
"account_type": "<string>",
"name": "<string>",
"access_token": "<string>",
"expires_at": "<string>",
"installation_id": 123,
"refresh_token": "<string>"
},
"github_helm_chart_releases": [
{
"authors": [
"<string>"
],
"body": "<string>",
"chart_resource_id": "<string>",
"created_at": "<string>",
"html_url": "<string>",
"release_id": "<string>",
"repository_name": "<string>",
"repository_owner": "<string>",
"version": "<string>",
"prerelease": false
}
],
"github_repositories": [
{
"credential_name": "<string>",
"default_branch": "<string>",
"git_url": "<string>",
"name": "<string>",
"owner": "<string>",
"private": true,
"web_url": "<string>"
}
],
"github_user_credential": {
"access_token": "<string>",
"account_login": "<string>",
"account_type": "<string>",
"ankra_user_id": "<string>",
"name": "<string>"
},
"global_github_helm_registry_repository": {
"registry_directory_path": "<string>",
"repository_name": "<string>",
"repository_owner": "<string>",
"branch": "master"
},
"helm_chart": {
"name": "<string>",
"registry_name": "<string>",
"registry_url": "<string>",
"github_release_scraper": {
"repository_name": "<string>",
"repository_owner": "<string>"
},
"versions": []
},
"helm_http_registry": {
"name": "<string>",
"url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"credential_name": "<string>",
"delete_permanently": false,
"exclude_charts": [],
"updated_at": "2023-11-07T05:31:56Z"
},
"helm_oci_registry": {
"name": "<string>",
"url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"credential_name": "<string>",
"delete_permanently": false,
"updated_at": "2023-11-07T05:31:56Z"
},
"helm_registry_credential": {
"name": "<string>",
"password": "<string>",
"username": "<string>"
},
"proxmox_cluster": {
"cluster_name": "<string>",
"credential": "<string>",
"network": {
"cidr": "<string>",
"name": "<string>",
"vlan": 123
},
"organisation_id": "<string>",
"vms": [
{
"cpu": 123,
"disk_gb": 123,
"memory_mb": 123,
"name": "<string>"
}
],
"ankra_agent": {
"url": "<string>",
"version": "<string>"
}
},
"proxmox_credentials": [
{
"host": "<string>",
"name": "<string>",
"port": 123,
"user": "<string>",
"bastion": {},
"password": "<string>",
"token_name": "<string>",
"token_value": "<string>"
}
]
}
}
'
{
  "errors": []
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Body

application/json
spec
PlatformResourceSpecification · object
required

Response

Successful Response

errors
ResourceError · object[]