Getting started

Setup

1. You must have curl installed on your machine. To check if curl is already installed, run curl --version- on the command line.

   • If the output provides information about the version of curl, that means curl is installed.
   • If you get a message similar to command not found: curl, that means curl is not installed. Download and install curl. For more information, see the curl download page.

2. Install the Endor Labs CLI on macOS, Windows, or Linux. For more information, see Install Endor Labs on your local system.

Authenticate

1. Authenticate with Endor Labs using endorctl init. For more information, see endorctl init.

   endorctl init --auth-mode google

2. Store the Endor Labs access token

   Run the following command from your terminal to get the Endor Labs access token.

   endorctl auth --print-access-token

Choose an endpoint for your request

Choose an endpoint to make a request to. You can explore the Endor Labs REST API documentation to discover endpoints that you can use to interact with Endor Labs.

Identify the HTTP method and path of the endpoint. You will send these with your request. For more information, see HTTP method and Path.

For example, the List Findings endpoint uses the HTTP method POST and the path /v1/namespaces/{tenant_meta.namespace}/findings.

Identify any required path parameters. Required path parameters appear in curly brackets {} in the path of the endpoint. Replace each parameter placeholder with the desired value. For more information, see Path.

For example, the List Findings endpoint uses the path /v1/namespaces/{tenant_meta.namespace}/findings, and the path parameter is {tenant_meta.namespace}. To use this path in your API request, replace {tenant_meta.namespace} with the name of the namespace where you want to list the findings.

Choose options for your request

Use the curl command to make your request. For more information, see the curl documentation.

Specify the following options and values in your request:

• --request or -X followed by the HTTP method as the value. For more information, see HTTP method.

  Note: You can also use the shorthand curl options --get and --post for GET and POST requests respectively.

• --header or -H:

  • Authorization: Pass your authentication token in an Authorization header. You must use Authorization: Bearer with the Endor Labs REST API. For more information, see Authentication.
  • Accept-Encoding: Provide the Accept-Encoding header in the following format: Accept-Encoding: gzip, deflate, br, zstd to avoid performance bottlenecks. For more information, see Accept-Encoding.
  • Content-Type: Set the header as Content-Type: application/jsoncompact to prevent Endor Labs APIs from returning null or empty value. For more information, see Content-Type.
  • Request-timeout: Specify the amount of time, in seconds, that you are willing to wait for a server response. For more information, see Request-timeout.

• --url followed by the full path as the value. The full path is a URL that includes the base URL for the Endor Labs REST API (https://api.endorlabs.com) and the path of the endpoint, like this: https://api.endorlabs.com/{PATH}. Replace {PATH} with the path of the endpoint. For more information, see Path.

  To use list parameters, add a ? to the end of the path, then append your list parameter name and value in the form list_parameter.parameter_name=value. Separate multiple list parameters with &. For example, to count the number of “Outdated Release” findings, use ?list_parameters.filter=meta.name==outdated_release&list_parameters.count=true. For more information, see List parameters.

  Note: Filters with spaces must be encoded when using curl. Replace spaces with %20 or use the --data-urlencode option for filters containing spaces.

• --data or -d followed by any body parameters within a json object. If you do not need to specify any body parameters in your request, omit this option. For more information, see Body parameters.

Make request

1. Using --url

   curl --request GET \
     --header "Authorization: Bearer $ENDOR_TOKEN" \
     --header "Accept-Encoding: gzip, deflate, br, zstd" \
     --header "Content-Type: application/jsoncompact" \
     --url "https://api.endorlabs.com/v1/namespaces/$ENDOR_NAMESPACE/findings?list_parameters.filter=spec.finding_tags%20contains%20FINDING_TAGS_REACHABLE_FUNCTION"
   

2. Using --data-urlencode

   curl --request GET \
     --header "Authorization: Bearer $ENDOR_TOKEN" \
     --header "Accept-Encoding: gzip, deflate, br, zstd" \
     --header "Content-Type: application/jsoncompact" \
     --data-urlencode "spec.finding_tags contains FINDING_TAGS_REACHABLE_FUNCTION" \
     "https://api.endorlabs.com/v1/namespaces/$ENDOR_NAMESPACE/findings"
   

Setup

Install the Endor Labs CLI on macOS, Windows, or Linux. For more information, see Install Endor Labs on your local system.

Authenticate

1. Authenticate with Endor Labs using endorctl init. For more information, see endorctl init.

   endorctl init --auth-mode google

2. Store the Endor Labs access token

   Run the following command from your terminal to get the Endor Labs access token.

   endorctl auth --print-access-token

Choose an endpoint for your request

Choose an endpoint to make a request to. You can explore the Endor Labs REST API documentation to discover endpoints that you can use to interact with Endor Labs.

Identify the HTTP method and path of the endpoint. You will send these with your request. For more information, see HTTP method and Path.

For example, the List Findings endpoint uses the HTTP method POST and the path /v1/namespaces/{tenant_meta.namespace}/findings.

Identify any required path parameters. Required path parameters appear in curly brackets {} in the path of the endpoint. Replace each parameter placeholder with the desired value. For more information, see Path.

For example, the List Findings endpoint uses the path /v1/namespaces/{tenant_meta.namespace}/findings, and the path parameter is {tenant_meta.namespace}. To use this path in your API request, replace {tenant_meta.namespace} with the name of the namespace where you want to list the findings.

Make a request

@baseUrl = https://api.endorlabs.com
@token = <insert-access-token>
@namespace = <insert-namespace>

###
GET {{baseUrl}}/v1/namespaces/{{namespace}}/findings?spec.finding_tags contains FINDING_TAGS_REACHABLE_FUNCTION HTTP/1.1
Authorization: Bearer {{token}}