Using the API test tool

If you use APIs to manage your Lumen® Vyvx® products, you can use the API test tool to test security keys, URI formatting and input parameters, whether a host is active, and many other things. The API test tool sends a single request to the servers so you can test requests and ver the responses back.

To use the API test tool:

  1. From the main menu, select Network Tools > API Test Tool.
  1. Type your API key and secret. (If you don't have an API security key, you can create one.)
  1. Select the host where you want to send the request. (In general, you'll use https://ws.lumen.com.)
  1. Fill in the information for your API request. To save some time filling in common types of requests (such as access groups or invalidation), you can select an option from the Template list and Media portal fills in some information for you.

    1. Type the URI and query.

    2. From the Method list, select the type of request your API call is making: GET, POST, PUT, or DELETE.

    3. If you're creating a request that needs to send information outside of the URI (such as a POST request), type the information into the Body field.
  1. From the Accept list, select the format you want the return data to be in (JSON or XML).
  1. If you're using a post body, use the Content-Type list to select the format of the data in the body (JSON or XML).
  1. When you're done, click Execute.

    Media portal sends your request and provides the HTTP status, signature, and response for your request.