API Use Cases

This document assumes that you can run curl in a command line on your system. You can also set up the REST calls in this book in other API clients such as:

• Postman
• Insomnia

If you run curl from the command line, we recommend that you use the jq command line JSON processor to format output.

Format JSON Responses

Without the | jq., you may have output that looks like:

{"pagination":{"next_page":null,"prev_page":null},"data":[{"resource":{"id":"YOUR-ORG-ID","name":"ORG-NAME","token":"YOUR-V2-ORGANIZATION-TOKEN"},"links":{"ui":{"url":"URL-WITH-YOUR-PENTESTS"}}}]}

If you add a | jq . to the end of your REST call, you may find it easier to read the output:

{
  "pagination": {
    "next_page": null,
    "prev_page": null
  },
  "data": [
    {
      "resource": {
        "id": "YOUR-ORG-ID",
        "name": "ORG-NAME",
        "token": "YOUR-V2-ORGANIZATION-TOKEN"
      },
      "links": {
        "ui": {
          "url": "URL-WITH-YOUR-PENTESTS"
        }
      }
    }
  ]
}

For your convenience, we include | jq . in all of our sample REST calls that provide actual output.