API Queries - Job Status

The job_status function lists the status and outcome of jobs that are not completed within 30 seconds such as add_domains and delete_domains.

Additional Parameters

• jobid - The ID of the job. (Required)

Example queries and responses:

In this example, we will request the status of the add_domains task with the jobid 4321.

Example query:
https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=job_status&jobid=4321

Response:

<results>

  <resultjobid="14521"status="Processing"/>

</results>

Possible statuses are "Pending", "Processing" and "Success". If the status is "Pending" or "Processing", you can run the query again in 30 seconds.

In this example, we will request the status of the add_domains task with the jobid 1234.

Example query:
https://www.above.com/api.php?username=user&password=pass&api_key=key&mode=job_status&jobid=1234

Response:

<resultsstatus="Success">

  <info>

    <resultmessage="1 domain is in conflict">

      <detail>

        <result>example.com</result>

      </detail>

    </result>

  <resultmessage="3 domains moved from Folder2 to (Default)">

    <detail>

      <result>example3.com</result>

      <result>example2.com</result>

      <result>example.com</result>

    </detail>

  </result>

  </info>

</results>

Error Responses:

Possible error responses for this function are:

• 411 - Job id is a required argument / Job was not found
• 500 - Job failed. Please contact support if problems persist.
• General errors, such as 200 - Internal Error or 300 - Username or password invalid.

For a complete list of error responses, see the Error Codes manual page.