Menu

Lumen help

Creating an HTTP task

Use Lumen® Edge Service Manager to create HTTP tasks. HTTP tasks use REST (representational state transfer) API calls to perform various actions through API communication between your instance and a server or application determined by URL address.

You can execute your automated task as a single task or combine it as part of an operational or provisioning workflow.

Note: Library tab functionality is only available for AWS (Amazon Web Services) and Azure cloud providers.

To create an HTTP task:

  1. Click Library, click Automation, then click Tasks.

    The Edge Service Manager shows the tasks created for your organization.
Edge Services Manager Library automation tasks view
  1. Click +Add.

    The Edge Service Manager shows the New Task window.
New Task window
  1. In the New Task window, complete the following fields:
Field Description
NAME Type a unique name for the HTTP task.
CODE Type a unique code for the HTTP task.
TYPE Select HTTP.
RESULT TYPE

Select one of the following options:

  • None—Task results are not returned.
  • Single Values—Task results are returned in a single string.
  • Key/Value Pairs—Task results are returned in key=value format.
  • JSON—Task results are returned in key pairs in JSON (JavaScript Object Notation) format. JSON is a data interchange format that uses readable text to store and transmit data consisting of attribute-value pairs and arrays.
URL Type a URL for the task to target.
HTTP METHOD

Type one of the following calls to determine the API call the task performs:

  • GET—Perform a GET call. GET calls retrieve resource information such as names, codes, and data.
  • POST—Perform a POST call. POST calls send resource information to a server. For example, use POST when creating new users and making updates to a library.
  • PATCH—Perform a PATCH call. PATCH calls update or upgrade a resource.
  • PUT—Perform a PUT call. PUT calls send information to a server. For example, use PUT to change information on a profile or modify a configuration.
  • HEAD—Perform a HEAD call. HEAD calls request information without a response body. 
  • DELETE—Perform a DELETE call. DELETE calls delete specified resources.
CREDENTIALS

Select one of the following options:

  • username and password—Create a new user to perform this task. This option enables the SECRET STORE and USERNAME fields.
  • Local Credentials—Use an existing user to perform this task. This option enables the AUTH PASSWORD field.
SECRET STORE This field defaults to Internal. The secret store is where the credentials for the new user are retained. This field is only available if you selected username and password for CREDENTIALS. 
USERNAME Type the username of the user you are creating. This field is only available if you selected username and password for CREDENTIALS.
AUTH PASSWORD Type the authorization password to use the locally stored credentials. This field is only available if you selected Local Credentials for CREDENTIALS. 
PASSWORD Type your password.
BODY Type your request query for the API call.
HTTP HEADERS Type the request headers in the Accept field and the text in the text/plain field to specify the format of the request query and provide authorization tokens or API keys. To add more headers, click the  icon.
IGNORE SSL HEADERS Select this option to allow API calls to systems without a trusted Secure Sockets Layer (SSL) certificate.
  1. In the Target Options section, leave the default selection as Local for EXECUTE TARGET.
  1. In the Execute Options section, complete the following fields:
Field Description
RETRYABLE Select this option to retry the task if it initially fails.
RETRY COUNT Type the maximum number of attempts to retry the task if it initially fails.
RETRY DELAY Type the amount of time (in seconds) the Edge Service Manager waits between retry attempts for the task.
ALLOW CUSTOM CONFIG Select this option to enable a text field to add extra variables or specifications to the task. This field appears in the Advanced Options section in the Execute Task? window when you manually execute a specific task.
  1. Click SAVE CHANGES.

    The Edge Service Manager creates the HTTP task.

Next, you can execute a single automated task or combine tasks in operational or provisioning workflows.