メインコンテンツへスキップ

activate-contract

dci activate-contract <customerID> <contractID>

Transitions a draft contract to active or scheduled (when the start date is in the future). Produces the same system state as activating via the Console. Requires the contractsManager permission. User API tokens must include it in their scope.

  • customerID — Identifier of the resource.
  • contractID — Identifier of the resource.

Examples​

# Preview the activation without sending a request.
dci activate-contract <customer-id> <contract-id> --dry-run
# Activate a draft contract, confirmed for scripts.
dci activate-contract <customer-id> <contract-id> --yes
`status` is `active`, or `scheduled` when the start date is in the future; a `409` means an active contract of the same type already exists for this tier.

Output​

OK - Contract activated or scheduled.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

FieldTypeDescription
contractIdstringThe contract identifier.
statusstringThe contract status after the operation (active, scheduled, or cancelled). One of: "active", "scheduled", "cancelled".
Raw JSON schema
{
"type": "object",
"description": "Result of an activate or cancel operation.",
"properties": {
"contractId": {
"type": "string",
"description": "The contract identifier."
},
"status": {
"type": "string",
"description": "The contract status after the operation (`active`, `scheduled`, or `cancelled`).",
"enum": [
"active",
"scheduled",
"cancelled"
]
}
}
}

Errors​

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping
HTTP statusExit codeError codeMeaning
40030VALIDATION_ERRORThe arguments or request body were rejected. Review the command's flags and payload.
40110AUTHENTICATION_FAILEDNot signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
40311PERMISSION_DENIEDThe DoiT user or the active customer context does not have access.
40420RESOURCE_NOT_FOUNDThe requested resource does not exist. Check the identifier argument.
40921RESOURCE_CONFLICTThe operation conflicts with the resource's current state.

Aliases: activatecontract