@opusdns/api 1.13.0 → 1.14.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^1.2.0"
   },
   "name": "@opusdns/api",
-  "version": "1.13.0",
+  "version": "1.14.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -52,6 +52,7 @@ import type {
   HolderEntitlement,
   HostStatus,
   HttpProtocol,
+  IPAddressType,
   InvoiceResponsePaymentStatus,
   InvoiceResponseStatus,
   InvoiceResponseType,
@@ -989,6 +990,16 @@ export const HTTP_PROTOCOL_VALUES = [
   'https',
 ] as const satisfies ReadonlyArray<HttpProtocol>;
 
+export const IP_ADDRESS_TYPE = {
+  V4: "v4",
+  V6: "v6",
+} as const satisfies Record<string, IPAddressType>;
+
+export const IP_ADDRESS_TYPE_VALUES = [
+  'v4',
+  'v6',
+] as const satisfies ReadonlyArray<IPAddressType>;
+
 export const INVOICE_RESPONSE_PAYMENT_STATUS = {
   PENDING: "pending",
   FAILED: "failed",

package/src/helpers/keys.ts

@@ -198,7 +198,11 @@ import type {
   GeoStatsBucket,
   GetPrices,
   HTTPValidationError,
+  HostCreate,
+  HostIpSchema,
+  Host,
   HostSchema,
+  HostUpdate,
   HttpRedirectList,
   HttpRedirectRemove,
   HttpRedirectRequest,
@@ -2786,6 +2790,44 @@ export const KEYS_HTTP_VALIDATION_ERROR = [
   KEY_HTTP_VALIDATION_ERROR_TYPE,
 ] as const satisfies (keyof HTTPValidationError)[];
 
+export const KEY_HOST_CREATE_HOSTNAME = 'hostname' satisfies keyof HostCreate;
+export const KEY_HOST_CREATE_IP_ADDRESSES = 'ip_addresses' satisfies keyof HostCreate;
+
+export const KEYS_HOST_CREATE = [
+  KEY_HOST_CREATE_HOSTNAME,
+  KEY_HOST_CREATE_IP_ADDRESSES,
+] as const satisfies (keyof HostCreate)[];
+
+export const KEY_HOST_IP_SCHEMA_ADDRESS = 'address' satisfies keyof HostIpSchema;
+export const KEY_HOST_IP_SCHEMA_CREATED_ON = 'created_on' satisfies keyof HostIpSchema;
+export const KEY_HOST_IP_SCHEMA_HOST_ID = 'host_id' satisfies keyof HostIpSchema;
+export const KEY_HOST_IP_SCHEMA_HOST_IP_ID = 'host_ip_id' satisfies keyof HostIpSchema;
+export const KEY_HOST_IP_SCHEMA_TYPE = 'type' satisfies keyof HostIpSchema;
+export const KEY_HOST_IP_SCHEMA_UPDATED_ON = 'updated_on' satisfies keyof HostIpSchema;
+
+export const KEYS_HOST_IP_SCHEMA = [
+  KEY_HOST_IP_SCHEMA_ADDRESS,
+  KEY_HOST_IP_SCHEMA_CREATED_ON,
+  KEY_HOST_IP_SCHEMA_HOST_ID,
+  KEY_HOST_IP_SCHEMA_HOST_IP_ID,
+  KEY_HOST_IP_SCHEMA_TYPE,
+  KEY_HOST_IP_SCHEMA_UPDATED_ON,
+] as const satisfies (keyof HostIpSchema)[];
+
+export const KEY_HOST_CREATED_ON = 'created_on' satisfies keyof Host;
+export const KEY_HOST_HOST_ID = 'host_id' satisfies keyof Host;
+export const KEY_HOST_HOSTNAME = 'hostname' satisfies keyof Host;
+export const KEY_HOST_IP_ADDRESSES = 'ip_addresses' satisfies keyof Host;
+export const KEY_HOST_UPDATED_ON = 'updated_on' satisfies keyof Host;
+
+export const KEYS_HOST = [
+  KEY_HOST_CREATED_ON,
+  KEY_HOST_HOST_ID,
+  KEY_HOST_HOSTNAME,
+  KEY_HOST_IP_ADDRESSES,
+  KEY_HOST_UPDATED_ON,
+] as const satisfies (keyof Host)[];
+
 export const KEY_HOST_SCHEMA_CREATED_ON = 'created_on' satisfies keyof HostSchema;
 export const KEY_HOST_SCHEMA_DOMAIN_ID = 'domain_id' satisfies keyof HostSchema;
 export const KEY_HOST_SCHEMA_HOST_ID = 'host_id' satisfies keyof HostSchema;
@@ -2804,6 +2846,12 @@ export const KEYS_HOST_SCHEMA = [
   KEY_HOST_SCHEMA_UPDATED_ON,
 ] as const satisfies (keyof HostSchema)[];
 
+export const KEY_HOST_UPDATE_IP_ADDRESSES = 'ip_addresses' satisfies keyof HostUpdate;
+
+export const KEYS_HOST_UPDATE = [
+  KEY_HOST_UPDATE_IP_ADDRESSES,
+] as const satisfies (keyof HostUpdate)[];
+
 export const KEY_HTTP_REDIRECT_LIST_PROTECTED = 'protected' satisfies keyof HttpRedirectList;
 export const KEY_HTTP_REDIRECT_LIST_REDIRECT_CODE = 'redirect_code' satisfies keyof HttpRedirectList;
 export const KEY_HTTP_REDIRECT_LIST_REQUEST_HOSTNAME = 'request_hostname' satisfies keyof HttpRedirectList;

package/src/helpers/requests.d.ts

@@ -29,6 +29,8 @@ import type {
   EmailForwardAliasCreate,
   EmailForwardAliasUpdate,
   EmailForwardCreate,
+  HostCreate,
+  HostUpdate,
   IpRestrictionCreate,
   IpRestrictionUpdate,
   JobBatchRequest,
@@ -654,6 +656,28 @@ export type PATCH_EventsByEventId_Request = {
 };
 export type PATCH_EventsByEventId_Request_Path = PATCH_EventsByEventId_Request['parameters']['path'];
 
+export type POST_Hosts_Request = {
+  requestBody: HostCreate;
+};
+export type POST_Hosts_Request_Body = POST_Hosts_Request['requestBody'];
+
+export type DELETE_HostsByHostReference_Request = {
+  parameters: operations['delete_host_v1_hosts__host_reference__delete']['parameters'];
+};
+export type DELETE_HostsByHostReference_Request_Path = DELETE_HostsByHostReference_Request['parameters']['path'];
+
+export type GET_HostsByHostReference_Request = {
+  parameters: operations['get_host_v1_hosts__host_reference__get']['parameters'];
+};
+export type GET_HostsByHostReference_Request_Path = GET_HostsByHostReference_Request['parameters']['path'];
+
+export type PUT_HostsByHostReference_Request = {
+  parameters: operations['update_host_v1_hosts__host_reference__put']['parameters'];
+  requestBody: HostUpdate;
+};
+export type PUT_HostsByHostReference_Request_Path = PUT_HostsByHostReference_Request['parameters']['path'];
+export type PUT_HostsByHostReference_Request_Body = PUT_HostsByHostReference_Request['requestBody'];
+
 export type DELETE_JobByJobId_Request = {
   parameters: operations['delete_job_v1_job__job_id__delete']['parameters'];
 };

package/src/helpers/responses.d.ts

@@ -44,6 +44,7 @@ import type {
   EventResponse,
   GetPrices,
   HTTPValidationError,
+  Host,
   IpRestriction,
   Job,
   JobBatchRetry,
@@ -174,6 +175,14 @@ export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403 =
 export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404 = Problem;
 export type DELETE_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422 = HTTPValidationError;
 
+export type DELETE_HostsByHostReference_Response = DELETE_HostsByHostReference_Response_401 | DELETE_HostsByHostReference_Response_403 | DELETE_HostsByHostReference_Response_404 | DELETE_HostsByHostReference_Response_409 | DELETE_HostsByHostReference_Response_422;
+
+export type DELETE_HostsByHostReference_Response_401 = Problem;
+export type DELETE_HostsByHostReference_Response_403 = Problem;
+export type DELETE_HostsByHostReference_Response_404 = Problem;
+export type DELETE_HostsByHostReference_Response_409 = Problem;
+export type DELETE_HostsByHostReference_Response_422 = HTTPValidationError;
+
 export type DELETE_JobByJobId_Response = DELETE_JobByJobId_Response_404 | DELETE_JobByJobId_Response_422;
 
 export type DELETE_JobByJobId_Response_404 = Problem;
@@ -547,6 +556,14 @@ export type GET_EventsByEventId_Response_401 = Problem;
 export type GET_EventsByEventId_Response_404 = Problem;
 export type GET_EventsByEventId_Response_422 = HTTPValidationError;
 
+export type GET_HostsByHostReference_Response = GET_HostsByHostReference_Response_200 | GET_HostsByHostReference_Response_401 | GET_HostsByHostReference_Response_403 | GET_HostsByHostReference_Response_404 | GET_HostsByHostReference_Response_422;
+
+export type GET_HostsByHostReference_Response_200 = Host;
+export type GET_HostsByHostReference_Response_401 = Problem;
+export type GET_HostsByHostReference_Response_403 = Problem;
+export type GET_HostsByHostReference_Response_404 = Problem;
+export type GET_HostsByHostReference_Response_422 = HTTPValidationError;
+
 export type GET_JobByJobId_Response = GET_JobByJobId_Response_200 | GET_JobByJobId_Response_404 | GET_JobByJobId_Response_422;
 
 export type GET_JobByJobId_Response_200 = Job;
@@ -1062,6 +1079,15 @@ export type POST_EmailForwardsByEmailForwardIdAliases_Response_404 = Problem;
 export type POST_EmailForwardsByEmailForwardIdAliases_Response_409 = Problem;
 export type POST_EmailForwardsByEmailForwardIdAliases_Response_422 = HTTPValidationError;
 
+export type POST_Hosts_Response = POST_Hosts_Response_201 | POST_Hosts_Response_401 | POST_Hosts_Response_403 | POST_Hosts_Response_404 | POST_Hosts_Response_409 | POST_Hosts_Response_422;
+
+export type POST_Hosts_Response_201 = Host;
+export type POST_Hosts_Response_401 = Problem;
+export type POST_Hosts_Response_403 = Problem;
+export type POST_Hosts_Response_404 = Problem;
+export type POST_Hosts_Response_409 = Problem;
+export type POST_Hosts_Response_422 = Problem;
+
 export type POST_JobByJobIdPause_Response = POST_JobByJobIdPause_Response_404 | POST_JobByJobIdPause_Response_422;
 
 export type POST_JobByJobIdPause_Response_404 = Problem;
@@ -1197,6 +1223,14 @@ export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_403 = Pro
 export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_404 = Problem;
 export type PUT_EmailForwardsByEmailForwardIdAliasesByAliasId_Response_422 = HTTPValidationError;
 
+export type PUT_HostsByHostReference_Response = PUT_HostsByHostReference_Response_200 | PUT_HostsByHostReference_Response_401 | PUT_HostsByHostReference_Response_403 | PUT_HostsByHostReference_Response_404 | PUT_HostsByHostReference_Response_422;
+
+export type PUT_HostsByHostReference_Response_200 = Host;
+export type PUT_HostsByHostReference_Response_401 = Problem;
+export type PUT_HostsByHostReference_Response_403 = Problem;
+export type PUT_HostsByHostReference_Response_404 = Problem;
+export type PUT_HostsByHostReference_Response_422 = HTTPValidationError;
+
 export type PUT_UsersByUserIdRole_Response = PUT_UsersByUserIdRole_Response_200 | PUT_UsersByUserIdRole_Response_403 | PUT_UsersByUserIdRole_Response_422;
 
 export type PUT_UsersByUserIdRole_Response_200 = PublicRoleAssignment;

package/src/helpers/schemas.d.ts

@@ -252,13 +252,18 @@ export type GetPrices = components['schemas']['GetPricesResponse'];
 export type HTTPMethod = components['schemas']['HTTPMethod'];
 export type HTTPValidationError = components['schemas']['HTTPValidationError'];
 export type HolderEntitlement = components['schemas']['HolderEntitlement'];
+export type HostCreate = components['schemas']['HostCreate'];
+export type HostIpSchema = components['schemas']['HostIpSchema'];
+export type Host = components['schemas']['HostResponse'];
 export type HostSchema = components['schemas']['HostSchema'];
 export type HostStatus = components['schemas']['HostStatus'];
+export type HostUpdate = components['schemas']['HostUpdate'];
 export type HttpProtocol = components['schemas']['HttpProtocol'];
 export type HttpRedirectList = components['schemas']['HttpRedirectListResponse'];
 export type HttpRedirectRemove = components['schemas']['HttpRedirectRemove'];
 export type HttpRedirectRequest = components['schemas']['HttpRedirectRequest'];
 export type HttpRedirectUpsert = components['schemas']['HttpRedirectUpsert'];
+export type IPAddressType = components['schemas']['IPAddressType'];
 export type IdnBase = components['schemas']['IdnBase'];
 export type Invoice = components['schemas']['InvoiceResponse'];
 export type InvoiceResponsePaymentStatus = components['schemas']['InvoiceResponsePaymentStatus'];

package/src/openapi.yaml

@@ -6446,6 +6446,113 @@ components:
       - licensee
       title: HolderEntitlement
       type: string
+    HostCreate:
+      properties:
+        hostname:
+          description: Hostname of the host object
+          examples:
+          - ns1.example.com
+          title: Hostname
+          type: string
+        ip_addresses:
+          description: List of IP addresses for the host object
+          examples:
+          - - 192.0.2.53
+            - 2001:db8::53
+          items:
+            format: ipvanyaddress
+            type: string
+          minItems: 1
+          title: Ip Addresses
+          type: array
+      required:
+      - hostname
+      - ip_addresses
+      title: HostCreate
+      type: object
+    HostIpSchema:
+      properties:
+        address:
+          description: IP address of the host object
+          format: ipvanyaddress
+          title: Address
+          type: string
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
+          type: string
+        host_id:
+          default: None
+          examples:
+          - host_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^host_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Host Id
+          type: string
+          x-typeid-prefix: host
+        host_ip_id:
+          examples:
+          - host_ip_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^host_ip_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Host Ip Id
+          type: string
+          x-typeid-prefix: host_ip
+        type:
+          $ref: '#/components/schemas/IPAddressType'
+          description: IP address type
+        updated_on:
+          description: The date/time the entry was last updated on
+          format: date-time
+          title: Updated On
+          type: string
+      required:
+      - address
+      - type
+      title: HostIpSchema
+      type: object
+    HostResponse:
+      properties:
+        created_on:
+          description: Timestamp when the host was created
+          format: date-time
+          title: Created On
+          type: string
+        host_id:
+          description: Unique identifier of the host object
+          examples:
+          - host_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^host_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Host Id
+          type: string
+          x-typeid-prefix: host
+        hostname:
+          description: Hostname of the host object
+          examples:
+          - ns1.example.com
+          title: Hostname
+          type: string
+        ip_addresses:
+          description: The ip addresses of the Host Object
+          items:
+            format: ipvanyaddress
+            type: string
+          title: Ip Addresses
+          type: array
+        updated_on:
+          description: Timestamp when the host was last updated
+          format: date-time
+          title: Updated On
+          type: string
+      required:
+      - host_id
+      - hostname
+      - created_on
+      - updated_on
+      title: HostResponse
+      type: object
     HostSchema:
       properties:
         created_on:
@@ -6508,6 +6615,23 @@ components:
       - pending_delete
       title: HostStatus
       type: string
+    HostUpdate:
+      properties:
+        ip_addresses:
+          description: List of IP addresses for the host object
+          examples:
+          - - 192.0.2.53
+            - 2001:db8::53
+          items:
+            format: ipvanyaddress
+            type: string
+          minItems: 1
+          title: Ip Addresses
+          type: array
+      required:
+      - ip_addresses
+      title: HostUpdate
+      type: object
     HttpProtocol:
       enum:
       - http
@@ -6632,6 +6756,12 @@ components:
       - request_hostname
       title: HttpRedirectUpsert
       type: object
+    IPAddressType:
+      enum:
+      - v4
+      - v6
+      title: IPAddressType
+      type: string
     IdnBase:
       properties:
         idn_capable:
@@ -12012,7 +12142,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-06-12-154603
+  version: 2026-06-12-181220
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -21949,6 +22079,346 @@ paths:
       - event
       x-required-permissions:
       - events:manage
+  /v1/hosts:
+    post:
+      description: Create a new host object
+      operationId: create_host_v1_hosts_post
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/HostCreate'
+        required: true
+      responses:
+        '201':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HostResponse'
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '403':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_PERMISSION_DENIED
+                detail: Additional error context.
+                status: 403
+                title: Permission Denied
+                type: permission-denied
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Forbidden
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_PARENT_DOMAIN_NOT_FOUND
+                detail: Parent domain not found for host 'Additional error context.'
+                hostname: Additional error context.
+                parent_domain: ''
+                status: 404
+                title: Host Management Error
+                type: parent-domain-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '409':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_HOST_ALREADY_EXISTS
+                detail: Host already exists
+                hostname: Additional error context.
+                status: 409
+                title: Host Management Error
+                type: host-already-exists
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Conflict
+        '422':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_HOST_OBJECTS_NOT_SUPPORTED
+                detail: Host objects are not supported for this tld
+                status: 422
+                title: Host Management Error
+                tld: Additional error context.
+                type: host-object-not-supported
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unprocessable Content
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Create a Host Object
+      tags:
+      - host
+      x-required-permissions:
+      - hosts:manage
+  /v1/hosts/{host_reference}:
+    delete:
+      description: Deletes a host object; only possible if the host is not in use
+      operationId: delete_host_v1_hosts__host_reference__delete
+      parameters:
+      - in: path
+        name: host_reference
+        required: true
+        schema:
+          anyOf:
+          - examples:
+            - host_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^host_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: host
+          - type: string
+          title: Host Reference
+      responses:
+        '204':
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '403':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_PERMISSION_DENIED
+                detail: Additional error context.
+                status: 403
+                title: Permission Denied
+                type: permission-denied
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Forbidden
+        '404':
+          content:
+            application/problem+json:
+              examples:
+                Host Management Error:
+                  value:
+                    code: ERROR_PARENT_DOMAIN_NOT_FOUND
+                    detail: Parent domain not found for host 'Additional error context.'
+                    hostname: Additional error context.
+                    parent_domain: ''
+                    status: 404
+                    title: Host Management Error
+                    type: parent-domain-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '409':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_HOST_IN_USE
+                detail: Host is linked to one or more domains
+                host_reference: Additional error context.
+                status: 409
+                title: Host Management Error
+                type: host-in-use
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Conflict
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Delete a Host Object
+      tags:
+      - host
+      x-required-permissions:
+      - hosts:delete
+    get:
+      description: Retrieves a host object by either its ID or hostname
+      operationId: get_host_v1_hosts__host_reference__get
+      parameters:
+      - in: path
+        name: host_reference
+        required: true
+        schema:
+          anyOf:
+          - examples:
+            - host_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^host_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: host
+          - type: string
+          title: Host Reference
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HostResponse'
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '403':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_PERMISSION_DENIED
+                detail: Additional error context.
+                status: 403
+                title: Permission Denied
+                type: permission-denied
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Forbidden
+        '404':
+          content:
+            application/problem+json:
+              examples:
+                Host Management Error:
+                  value:
+                    code: ERROR_PARENT_DOMAIN_NOT_FOUND
+                    detail: Parent domain not found for host 'Additional error context.'
+                    hostname: Additional error context.
+                    parent_domain: ''
+                    status: 404
+                    title: Host Management Error
+                    type: parent-domain-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Retrieve a Host Object
+      tags:
+      - host
+      x-required-permissions:
+      - hosts:read
+    put:
+      description: Updates the IP addresses of a host object, referenced by either
+        its ID or hostname
+      operationId: update_host_v1_hosts__host_reference__put
+      parameters:
+      - in: path
+        name: host_reference
+        required: true
+        schema:
+          anyOf:
+          - examples:
+            - host_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^host_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: host
+          - type: string
+          title: Host Reference
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/HostUpdate'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HostResponse'
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '403':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_PERMISSION_DENIED
+                detail: Additional error context.
+                status: 403
+                title: Permission Denied
+                type: permission-denied
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Forbidden
+        '404':
+          content:
+            application/problem+json:
+              examples:
+                Host Management Error:
+                  value:
+                    code: ERROR_PARENT_DOMAIN_NOT_FOUND
+                    detail: Parent domain not found for host 'Additional error context.'
+                    hostname: Additional error context.
+                    parent_domain: ''
+                    status: 404
+                    title: Host Management Error
+                    type: parent-domain-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Update a Host Object
+      tags:
+      - host
+      x-required-permissions:
+      - hosts:manage
   /v1/job/{job_id}:
     delete:
       operationId: delete_job_v1_job__job_id__delete
@@ -26557,6 +27027,31 @@ tags:
     '
   name: domain_search
   x-displayName: Domain search
+- description: "Endpoints for managing host objects (nameserver glue records).\n\n\
+    ### What is a host object?\n\nA host object represents a nameserver hostname registered\
+    \ at a registry. When a nameserver hostname is subordinate to a domain in your\
+    \ portfolio (e.g. `ns1.example.com` under `example.com`), the registry requires\
+    \ a host object carrying one or more IP addresses \u2014 commonly known as glue\
+    \ records \u2014 so that resolvers can reach the nameserver even though its address\
+    \ lives inside the zone it serves.\n\nThese endpoints manage **subordinate** host\
+    \ objects: the parent domain of the hostname must be managed in your OpusDNS account.\
+    \ Hostnames whose parent domain is not in your account are rejected with `ERROR_PARENT_DOMAIN_NOT_FOUND`.\
+    \ External nameservers (e.g. your DNS provider's hostnames) do not need host objects\
+    \ \u2014 simply reference them by hostname when setting a domain's nameservers.\n\
+    \n### Referencing a host\n\n`GET`, `PUT` and `DELETE` accept either the host ID\
+    \ (`host_...`) or the hostname as the `{host_reference}` path parameter.\n\n###\
+    \ Lifecycle\n\n- **Create** \u2014 `POST /v1/hosts` with the hostname and at least\
+    \ one IP address. The host object is created at the registry of the parent domain.\
+    \ Creating a host that already exists returns `ERROR_HOST_ALREADY_EXISTS`.\n-\
+    \ **Update** \u2014 `PUT /v1/hosts/{host_reference}` replaces the host's IP addresses\
+    \ with the provided list. If the provided addresses match the current state at\
+    \ the registry, the request succeeds without performing a registry update.\n-\
+    \ **Delete** \u2014 `DELETE /v1/hosts/{host_reference}` removes the host object.\
+    \ A host that is still in use as a nameserver by one or more domains cannot be\
+    \ deleted and returns `ERROR_HOST_IN_USE`.\n\nNot all TLDs use host objects; for\
+    \ TLDs without host object support, creation is rejected with `ERROR_HOST_OBJECTS_NOT_SUPPORTED`.\n"
+  name: host
+  x-displayName: Hosts
 - description: 'Endpoints for creating and managing email forwards.
 
     '
@@ -26682,6 +27177,7 @@ x-tagGroups:
   - domain
   - domain_tld_specific
   - tld
+  - host
   - contact
   - event
   - availability

package/src/schema.d.ts

@@ -1568,6 +1568,54 @@ export interface paths {
         patch: operations["acknowledge_event_v1_events__event_id__patch"];
         trace?: never;
     };
+    "/v1/hosts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create a Host Object
+         * @description Create a new host object
+         */
+        post: operations["create_host_v1_hosts_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/hosts/{host_reference}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve a Host Object
+         * @description Retrieves a host object by either its ID or hostname
+         */
+        get: operations["get_host_v1_hosts__host_reference__get"];
+        /**
+         * Update a Host Object
+         * @description Updates the IP addresses of a host object, referenced by either its ID or hostname
+         */
+        put: operations["update_host_v1_hosts__host_reference__put"];
+        post?: never;
+        /**
+         * Delete a Host Object
+         * @description Deletes a host object; only possible if the host is not in use
+         */
+        delete: operations["delete_host_v1_hosts__host_reference__delete"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/job/{job_id}": {
         parameters: {
             query?: never;
@@ -6731,6 +6779,93 @@ export interface components {
          * @enum {string}
          */
         HolderEntitlement: "owner" | "assignee" | "licensee";
+        /** HostCreate */
+        HostCreate: {
+            /**
+             * Hostname
+             * @description Hostname of the host object
+             * @example ns1.example.com
+             */
+            hostname: string;
+            /**
+             * Ip Addresses
+             * @description List of IP addresses for the host object
+             * @example [
+             *       "192.0.2.53",
+             *       "2001:db8::53"
+             *     ]
+             */
+            ip_addresses: string[];
+        };
+        /** HostIpSchema */
+        HostIpSchema: {
+            /**
+             * Address
+             * Format: ipvanyaddress
+             * @description IP address of the host object
+             */
+            address: string;
+            /**
+             * Created On
+             * Format: date-time
+             * @description The date/time the entry was created on
+             */
+            created_on?: Date;
+            /**
+             * Host Id
+             * Format: typeid
+             * @default None
+             * @example host_01h45ytscbebyvny4gc8cr8ma2
+             */
+            host_id: TypeId<"host">;
+            /**
+             * Host Ip Id
+             * Format: typeid
+             * @example host_ip_01h45ytscbebyvny4gc8cr8ma2
+             */
+            host_ip_id?: TypeId<"host_ip">;
+            /** @description IP address type */
+            type: components["schemas"]["IPAddressType"];
+            /**
+             * Updated On
+             * Format: date-time
+             * @description The date/time the entry was last updated on
+             */
+            updated_on?: Date;
+        };
+        /** HostResponse */
+        HostResponse: {
+            /**
+             * Created On
+             * Format: date-time
+             * @description Timestamp when the host was created
+             */
+            created_on: Date;
+            /**
+             * Host Id
+             * Format: typeid
+             * @description Unique identifier of the host object
+             * @example host_01h45ytscbebyvny4gc8cr8ma2
+             */
+            host_id: TypeId<"host">;
+            /**
+             * Hostname
+             * @description Hostname of the host object
+             * @example ns1.example.com
+             */
+            hostname: string;
+            /**
+             * Ip Addresses
+             * @description The ip addresses of the Host Object
+             */
+            ip_addresses?: string[];
+            /**
+             * Updated On
+             * Format: date-time
+             * @description Timestamp when the host was last updated
+             */
+            updated_on: Date;
+        };
         /** HostSchema */
         HostSchema: {
             /**
@@ -6780,6 +6915,18 @@ export interface components {
          * @enum {string}
          */
         HostStatus: "requested_create" | "pending_create" | "active" | "inactive" | "pending_delete";
+        /** HostUpdate */
+        HostUpdate: {
+            /**
+             * Ip Addresses
+             * @description List of IP addresses for the host object
+             * @example [
+             *       "192.0.2.53",
+             *       "2001:db8::53"
+             *     ]
+             */
+            ip_addresses: string[];
+        };
         /**
          * HttpProtocol
          * @enum {string}
@@ -6843,6 +6990,11 @@ export interface components {
             target_path: string;
             target_protocol: components["schemas"]["HttpProtocol"];
         };
+        /**
+         * IPAddressType
+         * @enum {string}
+         */
+        IPAddressType: "v4" | "v6";
         /** IdnBase */
         IdnBase: {
             /**
@@ -17687,6 +17839,349 @@ export interface operations {
             };
         };
     };
+    create_host_v1_hosts_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["HostCreate"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HostResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AUTHENTICATION",
+                     *       "detail": "Additional error context.",
+                     *       "status": 401,
+                     *       "title": "Authentication Error",
+                     *       "type": "authentication"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_PERMISSION_DENIED",
+                     *       "detail": "Additional error context.",
+                     *       "status": 403,
+                     *       "title": "Permission Denied",
+                     *       "type": "permission-denied"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_PARENT_DOMAIN_NOT_FOUND",
+                     *       "detail": "Parent domain not found for host 'Additional error context.'",
+                     *       "hostname": "Additional error context.",
+                     *       "parent_domain": "",
+                     *       "status": 404,
+                     *       "title": "Host Management Error",
+                     *       "type": "parent-domain-not-found"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_HOST_ALREADY_EXISTS",
+                     *       "detail": "Host already exists",
+                     *       "hostname": "Additional error context.",
+                     *       "status": 409,
+                     *       "title": "Host Management Error",
+                     *       "type": "host-already-exists"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Unprocessable Content */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_HOST_OBJECTS_NOT_SUPPORTED",
+                     *       "detail": "Host objects are not supported for this tld",
+                     *       "status": 422,
+                     *       "title": "Host Management Error",
+                     *       "tld": "Additional error context.",
+                     *       "type": "host-object-not-supported"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+        };
+    };
+    get_host_v1_hosts__host_reference__get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                host_reference: TypeId<"host"> | string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HostResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AUTHENTICATION",
+                     *       "detail": "Additional error context.",
+                     *       "status": 401,
+                     *       "title": "Authentication Error",
+                     *       "type": "authentication"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_PERMISSION_DENIED",
+                     *       "detail": "Additional error context.",
+                     *       "status": 403,
+                     *       "title": "Permission Denied",
+                     *       "type": "permission-denied"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    update_host_v1_hosts__host_reference__put: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                host_reference: TypeId<"host"> | string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["HostUpdate"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HostResponse"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AUTHENTICATION",
+                     *       "detail": "Additional error context.",
+                     *       "status": 401,
+                     *       "title": "Authentication Error",
+                     *       "type": "authentication"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_PERMISSION_DENIED",
+                     *       "detail": "Additional error context.",
+                     *       "status": 403,
+                     *       "title": "Permission Denied",
+                     *       "type": "permission-denied"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
+    delete_host_v1_hosts__host_reference__delete: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                host_reference: TypeId<"host"> | string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AUTHENTICATION",
+                     *       "detail": "Additional error context.",
+                     *       "status": 401,
+                     *       "title": "Authentication Error",
+                     *       "type": "authentication"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_PERMISSION_DENIED",
+                     *       "detail": "Additional error context.",
+                     *       "status": 403,
+                     *       "title": "Permission Denied",
+                     *       "type": "permission-denied"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Conflict */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_HOST_IN_USE",
+                     *       "detail": "Host is linked to one or more domains",
+                     *       "host_reference": "Additional error context.",
+                     *       "status": 409,
+                     *       "title": "Host Management Error",
+                     *       "type": "host-in-use"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_job_v1_job__job_id__get: {
         parameters: {
             query?: never;