> This page is for NVIDIA Kubernetes Engine.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.nvidia.com/nvke/llms.txt.

# Get the SPIRE server the cluster's nodes point at

GET https://nvke.acme.example/api/clusters/{clusterID}/spire-server

Returns the SPIRE server last requested through
`PATCH /clusters/{clusterID}/spire-server`, and for each node the
server its SPIRE agent points at and whether the agent holds a valid
X.509 SVID from it. Node status is read live from each node agent on
every call; an unreachable node is reported with `reachable: false`.

Reference: https://docs.nvidia.com/nvke/rest-api-reference/clusters/get-cluster-spire-server

## Authentication

- `Authorization` header (bearer token, required) — A JWT from an issuer the Operator has configured, carried as `Authorization: Bearer <token>`.

## Request

### Path parameters

- `clusterID` (string, required) — Cluster ID.

## Response

### 200

Requested server and live per-node SPIRE agent status

- `nodes` (list of NodeSpireAgentStatus, required) — Every node of the cluster.
- `requested` (SpireServer, optional) — The server last requested. Absent if none was requested.

## Errors

### 401 Unauthorized Error

No valid bearer token was presented.

- `message` (string, required) — What went wrong.

### 403 Forbidden Error

The token verified, but its subject matches no admission rule.

- `message` (string, required) — What went wrong.

### 404 Not Found Error

Cluster not found. No body is returned.

- `any`

## Types

### NodeSpireAgentStatus

One node's SPIRE agent, as reported live by its node agent.

- `nodeID` (string, required) — Node ID.
- `name` (string, required) — Node name.
- `reachable` (boolean, required) — The node agent answered. When false, only `message` is set.
- `hasValidSVID` (boolean, required) — The running SPIRE agent uses the config above and serves an unexpired X.509 SVID, so it holds a certificate from that server.
- `serverAddress` (string, optional) — SPIRE server address in the node's agent config.
- `serverPort` (integer, optional) — SPIRE server port in the node's agent config.
- `svidExpiresAt` (datetime, optional) — Expiry of that SVID.
- `message` (string, optional) — Why the node is unreachable or has no valid SVID.

### SpireServer

A SPIRE server address the cluster's SPIRE agents dial.

- `address` (string, required) — Host name or IP address of the SPIRE server.
- `port` (integer, required) — SPIRE server port.

## Examples

**Response**

```json
{
  "nodes": [
    {
      "nodeID": "string",
      "name": "string",
      "reachable": true,
      "hasValidSVID": true,
      "serverAddress": "string",
      "serverPort": 1,
      "svidExpiresAt": "2024-01-15T09:30:00Z",
      "message": "string"
    }
  ],
  "requested": {
    "address": "192.168.150.100",
    "port": 30440
  }
}
```

**SDK Code**

```python
import requests

url = "https://nvke.acme.example/api/clusters/clusterID/spire-server"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://nvke.acme.example/api/clusters/clusterID/spire-server';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://nvke.acme.example/api/clusters/clusterID/spire-server"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://nvke.acme.example/api/clusters/clusterID/spire-server")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://nvke.acme.example/api/clusters/clusterID/spire-server")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://nvke.acme.example/api/clusters/clusterID/spire-server', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://nvke.acme.example/api/clusters/clusterID/spire-server");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://nvke.acme.example/api/clusters/clusterID/spire-server")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```