Skip to main content
PATCH
/
load-balancers
/
{id}
/
domains
/
{domain_id}
Update load balancer system domain
curl --request PATCH \
  --url https://api.sevalla.com/v3/load-balancers/{id}/domains/{domain_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "my-lb"
}
'
{
  "id": "fb5e5168-4281-4bec-94c5-0d1584e9e657",
  "name": "app.example.com",
  "status": "ACTIVE",
  "type": "CUSTOM",
  "is_enabled": true,
  "is_wildcard": false,
  "is_primary": true,
  "dns_records": [
    {
      "type": "CNAME",
      "name": "app.example.com",
      "value": "cname.sevalla.com"
    }
  ],
  "errors": null,
  "created_at": "2025-01-30T00:00:00.000Z",
  "updated_at": "2025-01-30T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token in the Authorization header.

Path Parameters

​
id
string<uuid>
required

Load balancer identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

​
domain_id
string<uuid>
required

Domain identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

Body

application/json
​
name
string
required

New subdomain name for the system domain

Minimum string length: 1
Example:

"my-lb"

Response

Default Response

​
id
string<uuid>
required

Unique identifier for the domain

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

​
name
string
required

Domain name, either a custom domain or a system-assigned subdomain

Example:

"app.example.com"

​
status
string
required

Current verification and pointing status of the domain. VERIFICATION - domain ownership is being verified. POINTING - domain is verified but DNS is not yet pointing to the platform. ACTIVE - domain is fully configured and serving traffic. TIMED_OUT - verification or pointing timed out and needs to be refreshed.

Example:

"ACTIVE"

​
type
string
required

Domain type. SYSTEM - platform-assigned domain that can be toggled on/off. CUSTOM - user-added domain with custom DNS configuration.

Example:

"CUSTOM"

​
is_enabled
boolean
required

Whether the domain is currently enabled. Only applicable to system domains.

Example:

true

​
is_wildcard
boolean
required

Whether this is a wildcard domain that matches all subdomains

Example:

false

​
is_primary
boolean
required

Whether this domain is the primary domain for the service. The primary domain is used for canonical URLs.

Example:

true

​
dns_records
any | null
required

DNS records that need to be configured for this domain. Null when DNS configuration is not required.

Example:
[
  {
    "type": "CNAME",
    "name": "app.example.com",
    "value": "cname.sevalla.com"
  }
]
​
errors
any | null
required

Any errors encountered during domain verification or configuration

Example:

null

​
created_at
string<date-time>
required

Timestamp when the domain was created, in ISO 8601 format

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2025-01-30T00:00:00.000Z"

​
updated_at
string<date-time>
required

Timestamp when the domain was last modified, in ISO 8601 format

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Example:

"2025-01-30T00:00:00.000Z"