643 matches
100 actions
Hetzner Cloud
100 actions
Infrastructure/Hetzner Cloud
Returns all Action objects for a Certificate. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
Only type managed Certificates can have Actions. For type uploaded Certificates the actions key will always contain an empty array.
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"sort": {
"type": "string",
"enum": [
"id",
"id:asc",
"id:desc",
"command",
"command:asc",
"command:desc",
"status",
"status:asc",
"status:desc",
"progress",
"progress:asc",
"progress:desc",
"started",
"started:asc",
"started:desc",
"finished",
"finished:asc",
"finished:desc"
]
},
"status": {
"type": "string",
"enum": [
"running",
"success",
"error"
]
}
},
"required": [
"id"
],
"additionalProperties": false
}{
"type": "object",
"required": [
"actions"
],
"properties": {
"actions": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"command",
"status",
"progress",
"started",
"finished",
"resources",
"error"
],
"properties": {
"command": {
"type": "string",
"description": "Command executed in the Action"
},
"error": {
"type": "object",
"description": "Error message for the Action if error occurred, otherwise null",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string",
"description": "Fixed machine readable code"
},
"message": {
"type": "string",
"description": "Humanized error message"
}
}
},
"finished": {
"type": "string",
"description": "Point in time when the Action was finished (in ISO-8601 format). Only set if the Action is finished otherwise null."
},
"id": {
"type": "integer",
"description": "ID of the Resource"
},
"progress": {
"type": "number",
"description": "Progress of Action in percent"
},
"resources": {
"type": "array",
"description": "Resources the Action relates to",
"items": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "integer",
"description": "ID of the Resource"
},
"type": {
"type": "string",
"description": "Type of resource referenced"
}
}
}
},
"started": {
"type": "string",
"description": "Point in time when the Action was started (in ISO-8601 format)"
},
"status": {
"type": "string",
"description": "Status of the Action",
"enum": [
"success",
"running",
"error"
]
}
}
}
},
"meta": {
"type": "object",
"required": [
"pagination"
],
"properties": {
"pagination": {
"type": "object",
"required": [
"last_page",
"next_page",
"page",
"per_page",
"previous_page",
"total_entries"
],
"properties": {
"last_page": {
"type": "number",
"description": "ID of the last page available. Can be null if the current page is the last one."
},
"next_page": {
"type": "number",
"description": "ID of the next page. Can be null if the current page is the last one."
},
"page": {
"type": "number",
"description": "Current page number"
},
"per_page": {
"type": "number",
"description": "Maximum number of items shown per page in the response"
},
"previous_page": {
"type": "number",
"description": "ID of the previous page. Can be null if the current page is the first one."
},
"total_entries": {
"type": "number",
"description": "The total number of entries that exist in the database for this query. Nullable if unknown."
}
}
}
}
}
}
}