Generate kubeconfig for a cluster

POST 
https://api.astropulse.io/api/v1/clusters/:clusterId/kubeconfig/generate

Generates a new kubeconfig file for a specific Kubernetes cluster

Request

Path Parameters

clusterId stringrequired

Cluster ID

Header Parameters

X-Astro-API-Key stringrequired

APIKey

Responses

200

Kubeconfig generated successfully

application/json

Schema

Schema

data object
clusterNamestringrequired
clusterName is the name of the cluster
Possible values: non-empty and <= 50 characters
credentials objectrequired
credentials maps to the cloud provider credentials
data objectrequired
data is the data for the credentials, the data is in the format of key-value pairs
property name*string
typestringrequired
type is the type of the credentials it expects, the supported types are static and dynamic if the type is static then platform aspects the standard ENV keys for cloud provider. Please follow the astro platform documentation for the keys. If the type is dynamic then the platform will use cloud provider supported capability to generate the credentials. Like for AWS it will use the STS assume role capability.
Possible values: [dynamic, static]
durationintegerrequired
duration is the duration for which the kubeconfig is valid. The valid duration takes the pattern as 1h, 1m etc
Possible values: [-9223372036854776000, 9223372036854776000, 1, 1000, 1000000, 1000000000, 60000000000, 3600000000000]
idstring
messagestring
statusstring

Example (auto)

{
  "data": {
    "clusterName": "string",
    "credentials": {
      "data": {},
      "type": "dynamic"
    },
    "duration": -9223372036854776000
  },
  "id": "string",
  "message": "string",
  "status": "string"
}

400

Invalid cluster ID

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

401

Missing or invalid API key

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

403

User does not have permission to generate kubeconfig

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

404

Cluster not found

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

409

Cluster is not in a valid state for kubeconfig generation

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

429

Rate limit exceeded

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

500

Internal server error

application/json

Schema

Schema

body object
Error response in: body
detailsobject
errorstring
Example: Resource not found
error_codestring
Example: NOT_FOUND
statusinteger
Example: 404
trace_idstring
Example: trace-5e6f7g8h9i

Example (auto)

{
  "body": {
    "details": {},
    "error": "Resource not found",
    "error_code": "NOT_FOUND",
    "status": 404,
    "trace_id": "trace-5e6f7g8h9i"
  }
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://api.astropulse.io/api/v1/clusters/:clusterId/kubeconfig/generate");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.astropulse.io

Parameters

clusterId — pathrequired

X-Astro-API-Key — headerrequired