Pending DNS API tasks can be retrieved and/or cancelled before they are finished. Use the instructions on this page to retrieve all pending tasks.
Understanding How The API Works »
REST Syntax
| Click to view all REST Resources |
| Task/ GET — Retrieves a list of all current DNS API tasks.
HTTP Action — GET
URI — https://api.dynect.net/REST/Task/ |
Arguments:
name – Limits results to tasks with the given name. May also take the special value blocking to indicate any task where blocking = Y.zone_name – Limits results to tasks for the given zone.status – Limits results to tasks with the given status.
Valid values:
done = Any finished task, successful or not.
notdone = Any task unfinished.
|
Response — Click for More Info
- integer
task_id — Unique identifier for the task.
- string
name — Identifying name of the task.
- string
customer_name — Your customer account name.
- string
zone_name — Name of the zone where you created the task.
- string
status — Status of the task when you requested the information.
Valid values:
ready, running, waiting, complete, failed, canceled, or stalled.
- integer
step_count — Some tasks have multiple steps, step_count indicates the number of steps in the task that are completed.
- integer
total_steps — Some tasks have multiple steps, total_steps indicates the total number of steps in the task.
- boolean
blocking — Indicates if the task if the task is blocking other zone changes.
Valid values:
Y = yes, this task will block additional zone changes until it finishes.
N = no, this task does not block additional zone changes.
- string
message — Information about the state of the task. Error codes may appear here.
- string
debug — Internal Dyn use.
- datetime
created_ts — Timestamp, in POSIX format, indicating when you created the task.
- datetime
modified_ts — Timestamp, in POSIX format, indicating when the task was modified.
|
SOAP Syntax
| Click to view all SOAP Commands |
| GetTasks — Retrieves the list of all pending DNS API tasks. |
Arguments:
- string
token — Required. The session identifier.
name – Limits results to tasks with the given name. May also take the special value blocking to indicate any task where blocking = Y.zone_name – Limits results to tasks for the given zone.status – Limits results to tasks with the given status.
Valid values:
done = Any finished task, successful or not.
notdone = Any task unfinished.
|
Response — Click for More Info
- hash data
- string
token — Required. The session identifier.
- integer
task_id — Unique identifier for the task.
- string
name — Identifying name of the task.
- string
customer_name — Your customer account name.
- string
zone_name — Name of the zone where you created the task.
- string
status — Status of the task when you requested the information.
Valid values:
ready, running, waiting, complete, failed, canceled, or stalled.
- integer
step_count — Some tasks have multiple steps, step_count indicates the number of steps in the task that are completed.
- integer
total_steps — Some tasks have multiple steps, total_steps indicates the total number of steps in the task.
- boolean
blocking — Indicates if the task if the task is blocking other zone changes.
Valid values:
Y = yes, this task will block additional zone changes until it finishes.
N = no, this task does not block additional zone changes.
- string
message — Information about the state of the task. Error codes may appear here.
- string
debug — Internal Dyn use.
- datetime
created_ts — Timestamp, in POSIX format, indicating when you created the task.
- datetime
modified_ts — Timestamp, in POSIX format, indicating when the task was modified.
|
Example Request — Click for More Info
{
'zone_name' => 'New_York',
'token' => 'asdlkfjasl23j4879afa',
}
|
<< DNS API Knowledge Base
