Skip to content
Aether Docs

Set cluster network policy

PUT
/api/v1/organizations/{orgID}/clusters/{clusterID}/network
curl --request PUT \
  --url https://api.aetherplatform.cloud/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/network \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "authorized_cidrs": [ "example" ], "api_server_rate_limit": { "max_connections_per_second": 1, "burst": 1 } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
orgID
required
string format: uuid

Organization UUID.

clusterID
required
string format: uuid

Cluster UUID.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
authorized_cidrs
required

Source-IP allowlist (CIDRs) for reaching the cluster’s control plane. An empty list means connections are accepted from any source address; authentication still applies. Send at least one CIDR to restrict it. The list restricts the public control-plane endpoint — where the cluster’s own workers and the platform are always allowed in addition to it — and, where the platform kubectl proxy is enabled, connections made through it, which are matched against these entries alone — a private cluster reached through the proxy is matched like any other. It has no effect on the private control-plane path itself, which has no public listener. Replaces the stored list outright; every entry must be CIDR notation, and a bare address is rejected with 422 authorized_cidrs/invalid_cidr.

Array<string>
api_server_rate_limit
One of:
object
max_connections_per_second
required
integer
>= 1
burst
required
integer
>= 1
Examplegenerated
{
  "authorized_cidrs": [
    "example"
  ],
  "api_server_rate_limit": {
    "max_connections_per_second": 1,
    "burst": 1
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

The updated cluster network policy.

Media typeapplication/json
object
cluster_id
required
string format: uuid
authorized_cidrs
required

Source-IP allowlist (CIDRs) for reaching the cluster’s control plane. An empty list means connections are accepted from any source address; authentication still applies. Send at least one CIDR to restrict it. The list restricts the public control-plane endpoint — where the cluster’s own workers and the platform are always allowed in addition to it — and, where the platform kubectl proxy is enabled, connections made through it, which are matched against these entries alone — a private cluster reached through the proxy is matched like any other. It has no effect on the private control-plane path itself, which has no public listener.

Array<string>
api_server_rate_limit
One of:
object
max_connections_per_second
required
integer
>= 1
burst
required
integer
>= 1
updated_at
required
string format: date-time
Examplegenerated
{
  "cluster_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "authorized_cidrs": [
    "example"
  ],
  "api_server_rate_limit": {
    "max_connections_per_second": 1,
    "burst": 1
  },
  "updated_at": "2026-04-15T12:00:00Z"
}

401

Section titled “401”

Missing or invalid credentials.

Media typeapplication/json
object
error
required
object
code
required

A stable, machine-readable error code.

string
message
required
string
details
Array<object>
object
field
required
string
code
required
string
message
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

404

Section titled “404”

The requested resource was not found.

Media typeapplication/json
object
error
required
object
code
required

A stable, machine-readable error code.

string
message
required
string
details
Array<object>
object
field
required
string
code
required
string
message
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

422

Section titled “422”

Request validation failed.

Media typeapplication/json
object
error
required
object
code
required

A stable, machine-readable error code.

string
message
required
string
details
Array<object>
object
field
required
string
code
required
string
message
required
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}