Register a new DCV policy

Register a new DCV policy

Body required
application/json

DCV policy to register

name
string required

Unique name of the DCV policy
provider
string required

Name of the DCV provider configuration to use
provisioner
string required

Name of the DCV provisioner configuration to use
executionTimeout
string | null (FiniteDuration) required

Maximum duration for a single DCV run
retryDelay
string | null (FiniteDuration) required

Delay between retry attempts
filter
string | null

Optional regex filter applied to domain hostnames
renewalPolicy
object | null (DCVRenewalPolicy)

Renewal scheduling policy; if absent no automatic renewal is triggered
enabled
boolean

Whether the DCV policy is enabled; disabled policies are not scheduled
triggers
object | null (DCVPolicyTriggers)

Optional trigger configuration for DCV lifecycle events
Responses
  • 201 DCV policy successfully registered
    _id
    string (Internal ID) required

    Object internal ID
    name
    string required

    Unique name of the DCV policy
    provider
    string required

    Name of the DCV provider configuration to use
    provisioner
    string required

    Name of the DCV provisioner configuration to use
    executionTimeout
    string | null (FiniteDuration) required

    Maximum duration for a single DCV run
    retryDelay
    string | null (FiniteDuration) required

    Delay between retry attempts
    filter
    string | null

    Optional regex filter applied to domain hostnames
    renewalPolicy
    object | null (DCVRenewalPolicy)

    Renewal scheduling policy; if absent no automatic renewal is triggered
    enabled
    boolean

    Whether the DCV policy is enabled; disabled policies are not scheduled
    triggers
    object | null (DCVPolicyTriggers)

    Optional trigger configuration for DCV lifecycle events
  • 400 Bad Request
  • 401 Unauthorized request
  • 403 Forbidden action
  • 500 Internal Server error