Updated on 2026-09-30 GMT+08:00

Uploading a Chart

Function

This API is used to upload a chart.

Calling Method

For details, see Calling APIs.

URI

POST /v2/charts

Request Parameters

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition: Type (or format) of the request body. The default value is application/json. Other values of this field will be provided for specific APIs, if any. Constraints: GET requests are not validated. Range: N/A Default Value: N/A
X-Auth-Token	Yes	String	Details: Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see Obtaining a User Token. Constraints: None Options: N/A Default value: N/A

**Table 2** FormData parameters
Parameter	Mandatory	Type	Description
parameters	No	String	Definition: Parameter configurations for uploading a chart, for example, {"override":true,"skip_lint":true,"source":"package"} Constraints: N/A Range: skip_lint: whether to verify the uploaded chart override: whether to override an existing chart visible: whether the chart is visible Default Value: N/A
content	Yes	File	Definition: Chart package file Constraints: N/A Range: N/A Default Value: N/A

Response Parameters

Status code: 201

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Definition: Chart ID Range: N/A
name	String	Definition: Name Range: N/A
values	String	Definition: Chart value Range: N/A
translate	String	Definition: Chart translation resources Range: N/A
instruction	String	Definition: Chart introduction Range: N/A
version	String	Definition: Chart version Range: N/A
description	String	Definition: Chart description Range: N/A
source	String	Definition: Chart source Range: N/A
icon_url	String	Definition: URL to the chart icon Range: N/A
public	Boolean	Definition: Whether the chart is public Range: true: The chart is public. false: The chart is not public.
chart_url	String	Definition: URL to the chart Range: N/A
create_at	String	Definition: Creation time Range: N/A
update_at	String	Definition: Update time Range: N/A

Example Requests

If the FormData parameter is present, multipart/form-data should be used in Content-Type and the file path should be specified.

POST /v2/charts -H "X-Auth-Token:$token" -H "Content-Type:multipart/form-data" -F parameters='{"skip_lint":true,"override":true,"source":"package"}' -F content=@/root/neo4j-3.0.1.tgz

Example Responses

Status code: 201

{
  "id" : "e99a7e86-afdd-11eb-aca3-0255ac100b0e",
  "name" : "neo4j",
  "values" : "{\"acceptLicenseAgreement\":\"no\",\"affinity\":{},\"authEnabled\":true,\"clusterDomain\":\"cluster.local\",\"core\":{\"initContainers\":[],\"numberOfServers\":3,\"persistentVolume\":{\"enabled\":true,\"mountPath\":\"/data\",\"size\":\"10Gi\"},\"sidecarContainers\":[]},\"defaultDatabase\":\"neo4j\",\"image\":\"neo4j\",\"imagePullPolicy\":\"IfNotPresent\",\"imageTag\":\"4.0.3-enterprise\",\"name\":\"neo4j\",\"nodeSelector\":{},\"podDisruptionBudget\":{},\"readReplica\":{\"autoscaling\":{\"enabled\":false,\"maxReplicas\":3,\"minReplicas\":1,\"targetAverageUtilization\":70},\"initContainers\":[],\"numberOfServers\":0,\"resources\":{},\"sidecarContainers\":[]},\"resources\":{},\"testImage\":\"markhneedham/k8s-kubectl\",\"testImageTag\":\"master\",\"tolerations\":[],\"useAPOC\":\"true\"}",
  "translate" : "",
  "instruction" : "README.md",
  "version" : "3.0.1",
  "description" : "DEPRECATED Neo4j is the world's leading graph database",
  "source" : "",
  "icon_url" : "https://info.neo4j.com/rs/773-GON-065/images/neo4j_logo.png",
  "public" : false,
  "chart_url" : "neo4j-3.0.1.tgz",
  "create_at" : "2021-05-08T08:53:13Z",
  "update_at" : "2021-05-08T08:53:13Z"
}

Status Codes

Status Code	Description
201	The chart has been uploaded.

Error Codes

See Error Codes.

Parent topic: Chart Management