Automation API



Get API Key

GET /automation/apikey

Description

Gets Automation API Key.


Parameters

TypeNameDescriptionRequiredSchemaDefault

QueryParameter

projectId

Project ID of the selected project.

true

integer (int64)



Responses

HTTP CodeDescriptionSchema

200

Successful operation.

No Content

400

Returned if the given project is invalid.

No Content

403

Returned if user does not have permission to get apiKey of the given project.

No Content

404

Returned if the required request data is not provided.

No Content

500

Returned if there is some problem in fetching API Key.

No Content


Produces

  • application/json


Tags

  • Automation


Generate API Key

POST /automation/apikey/{projectId}

Description

Generates a new Automation API Key for the given project and user.


Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

projectId

Project ID of the selected project.

true

integer (int64)



Responses

HTTP CodeDescriptionSchema

200

Successful operation.

No Content

400

Returned if the given project is invalid.

No Content

403

Returned if user does not have permission to create apiKey in the given project.

No Content

404

Returned if the required request data is not provided.

No Content

500

Returned if there is some problem in creating API Key.

No Content


Produces

  • application/json


Tags

  • Automation


Edit Automation Attributes

POST /automation/{issueId}/attributes

Description

Edits Automation Attributes of the given issue.


Parameters

TypeNameDescriptionRequiredSchemaDefault

PathParameter

issueId

Issue Id.

true

integer (int64)


BodyParameter

body

Automation Attributes Object to be edited.

true

AutomationAttributes



Responses

HTTP CodeDescriptionSchema

200

Successful operation.

No Content

400

Returned if the given issue is invalid.

No Content

403

Returned if user does not have permission to edit the given issue.

No Content

404

Returned if the required request data is not provided.

No Content

500

Returned if there is some problem in editing the automation attributes.

No Content


Produces

  • application/json


Tags

  • Automation



AutomationAttributes

NameDescriptionRequiredSchemaDefault

automationId1

Automation ID 1

false

string


automationId2

Automation ID 2

false

string