Jump to

• Request
• Response

Relaunch a Job

post

/api/v2/jobs/{id}/relaunch/

Make a POST request to this resource to launch a job. If any passwords or variables are required then they should be passed in via POST data. In order to determine what values are required in order to launch a job based on this job template you may make a GET request to this endpoint.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string

Body ()

Root Schema : JobRelaunch

Type: object

Show Source

• credential_passwords(required): string
  Title: Credential passwords
• hosts: string
  Title: Hosts

  Default Value: all

  Allowed Values: [ "all", "failed" ]
• passwords_needed_to_start: string
  Title: Passwords needed to start

  Read Only: true
• retry_counts: string
  Title: Retry counts

  Read Only: true

{
    "properties":{
        "credential_passwords":{
            "title":"Credential passwords",
            "type":"string"
        },
        "hosts":{
            "default":"all",
            "enum":[
                "all",
                "failed"
            ],
            "title":"Hosts",
            "type":"string",
            "x-nullable":true
        },
        "passwords_needed_to_start":{
            "readOnly":true,
            "title":"Passwords needed to start",
            "type":"string"
        },
        "retry_counts":{
            "readOnly":true,
            "title":"Retry counts",
            "type":"string"
        }
    },
    "required":[
        "credential_passwords"
    ],
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Body ()

Root Schema : JobRelaunch

Type: object

Show Source

• credential_passwords(required): string
  Title: Credential passwords
• hosts: string
  Title: Hosts

  Default Value: all

  Allowed Values: [ "all", "failed" ]
• passwords_needed_to_start: string
  Title: Passwords needed to start

  Read Only: true
• retry_counts: string
  Title: Retry counts

  Read Only: true

{
    "properties":{
        "credential_passwords":{
            "title":"Credential passwords",
            "type":"string"
        },
        "hosts":{
            "default":"all",
            "enum":[
                "all",
                "failed"
            ],
            "title":"Hosts",
            "type":"string",
            "x-nullable":true
        },
        "passwords_needed_to_start":{
            "readOnly":true,
            "title":"Passwords needed to start",
            "type":"string"
        },
        "retry_counts":{
            "readOnly":true,
            "title":"Retry counts",
            "type":"string"
        }
    },
    "required":[
        "credential_passwords"
    ],
    "type":"object"
}

Back to Top