# Retry Task
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/be/v1/trigger:
post:
summary: Retry Task
deprecated: false
description: >-
This endpoint is used to retry a failed task in ROCKIT Edge. If a task
has failed due to incorrect parameters or a temporary issue, this
endpoint allows triggering a retry after the issue has been resolved.
There are various issues which may cause a deployment task to fail such
as:
- invalid Deployment parameters (such as credentials)
- destination origin is temporarily not reachable.
If a deployment task fails the *App* goes into an error state until the
issue has been resolved. If the *Deployment* has invalid parameters
please fix it first (see [Modify
Deployment](https://edge.api.cloud.rockitplay.com/modify-deployment-11695719e0.md))
and invoke this endpoint.
It the destination origin is not reachable please contact the origin's
administrator / support. Once the issue has been resolved initiate a
retry by invoking this endpoint.
### Required Permissions
`trigger.create`
See [Roles](https://edge.api.cloud.rockitplay.com/roles-3618377f0.md)
for more details.
tags:
- ROCKIT Edge - Backend API/Triggers
parameters:
- name: Authorization
in: header
description: >-
Use the access token obtained from [`POST
/be/v1/login`](https://edge.api.cloud.rockitplay.com/user-login-org-11611254e0.md)
or [`POST
/be/v1/refresh`](https://edge.api.cloud.rockitplay.com/refresh-11630082e0.md)
as Bearer token.
Mutually excluded with `x-rockit-api-key`.
required: true
example: Bearer {{_edge_org_admin_access_token}}
schema:
type: string
- name: x-rockit-tenant
in: header
description: >
Unique and immutable tenancy identifier obtained from the ROCKIT
Edge administrator.
Requires `x-rockit-username`,
`x-rockit-orgname` and `x-rockit-api-key`.
required: true
example: '{{EDGE_TENANT_NAME}}'
schema:
type: string
- name: x-rockit-orgname
in: header
description: >
Unique and immutable organization identifier obtained from the
ROCKIT Edge administrator.
Requires `x-rockit-tenant`,
`x-rockit-username` and `x-rockit-api-key`.
required: true
example: '{{EDGE_ORG_NAME}}'
schema:
type: string
- name: x-rockit-username
in: header
description: >
Unique and immutable username which is associated with the apikey.
Requires `x-rockit-tenant`, `x-rockit-orgname` and
`x-rockit-api-key`.
required: true
example: adminPrincipal
schema:
type: string
- name: x-rockit-api-key
in: header
description: >-
Unique and immutable apikey which is associated with an machine
user.
Mutually excluded with `Authorization` header. Requires
`x-rockit-tenant`, `x-rockit-username` and `x-rockit-orgname`.
required: true
example: '{{_adminPrincipal_apiKey}}'
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
retry:
type: object
properties:
taskName:
type: string
description: Identifier of the Task.
x-apidog-orders:
- taskName
required:
- taskName
description: 'Type of event, here: ''retry'' for retrying a failed task.'
x-apidog-ignore-properties: []
required:
- retry
x-apidog-orders:
- retry
x-apidog-ignore-properties: []
example:
retry:
taskName: exampleTask
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
statusCode:
type: integer
description: >-
An integer (typically 200) indicating that the retry
request was accepted.
status:
type: string
description: >-
A string confirming that the retry operation was
successful.
message:
type: string
description: >-
A confirmation message (such as "publish task triggered")
that indicates the retry action has been initiated.
required:
- statusCode
- status
- message
x-apidog-orders:
- statusCode
- status
- message
x-apidog-ignore-properties: []
example:
statusCode: 200
status: success
message: publish task triggered
headers: {}
x-apidog-name: Success
'400':
description: ''
content:
application/json:
schema:
title: ''
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more
invalid or missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example,
"name invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected
pattern for the organization name)
x-apidog-orders:
- 01JQNHSE1WKNKX235DDC15WD7A
required:
- status
- error
- message
- detail
x-apidog-refs:
01JQNHSE1WKNKX235DDC15WD7A:
$ref: '#/components/schemas/Invalid%20Param'
x-apidog-ignore-properties:
- status
- error
- message
- detail
headers: {}
x-apidog-name: Invalid Param
'401':
description: ''
content:
application/json:
schema:
title: ''
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was
rejected because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose
the failure.
x-apidog-orders:
- 01JQNHRXB3Q1M9QG544970PG6Z
required:
- status
- error
- message
x-apidog-refs:
01JQNHRXB3Q1M9QG544970PG6Z:
$ref: '#/components/schemas/unauthorized'
x-apidog-ignore-properties:
- status
- error
- message
headers: {}
x-apidog-name: Unauthorized
security: []
x-apidog-folder: ROCKIT Edge - Backend API/Triggers
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/732774/apis/api-12373263-run
components:
schemas:
unauthorized:
type: object
properties:
status:
type: string
description: >-
Indicates that the organization creation request was rejected
because of authentication problems.
error:
type: string
description: Contains an error identifier. (e.g."unauthorized")
message:
type: string
description: >-
Provides details such as "invalid token" to help diagnose the
failure.
required:
- status
- error
- message
x-apidog-orders:
- status
- error
- message
x-apidog-ignore-properties: []
x-apidog-folder: ''
Invalid Param:
type: object
properties:
status:
type: string
description: >-
Reflects that the creation failed due to one or more invalid or
missing parameters in the request.
error:
type: string
description: Contains an error identifier. (e.g., "invalid-param")
message:
type: string
description: >-
Explains the nature of the invalid input (for example, "name
invalid").
detail:
type: string
description: >-
Offers further context on the error. (e.g., expected pattern for the
organization name)
required:
- status
- error
- message
- detail
x-apidog-orders:
- status
- error
- message
- detail
x-apidog-ignore-properties: []
x-apidog-folder: ''
securitySchemes:
Bearer token:
type: bearer
scheme: bearer
description: >-
Enter your Access Token. You can obtain this by calling the /be/v1/login
endpoint. Use the Refresh token to get a new Access token when it
expires.
servers:
- url: https://Example-Server.com
description: Default
security: []
```