List policies - Semgrep

List policies

curl --request GET \
  --url https://semgrep.dev/api/policies/v1/deployments/{deploymentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://semgrep.dev/api/policies/v1/deployments/{deploymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://semgrep.dev/api/policies/v1/deployments/{deploymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://semgrep.dev/api/policies/v1/deployments/{deploymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://semgrep.dev/api/policies/v1/deployments/{deploymentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://semgrep.dev/api/policies/v1/deployments/{deploymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "policies": [
    {
      "id": "1",
      "name": "Global Policy",
      "slug": "global_policy",
      "productType": "PRODUCT_TYPE_SAST",
      "isDefault": true
    },
    {
      "id": "2",
      "name": "Semgrep test",
      "slug": "semgrep_test",
      "productType": "PRODUCT_TYPE_SAST",
      "isDefault": false
    },
    {
      "id": "3",
      "name": "Global Secrets Policy",
      "slug": "global_secrets_policy",
      "productType": "PRODUCT_TYPE_SECRETS",
      "isDefault": true
    }
  ]
}

GET

/

api

/

policies

/

v1

/

deployments

/

{deploymentId}

List policies

curl --request GET \
  --url https://semgrep.dev/api/policies/v1/deployments/{deploymentId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://semgrep.dev/api/policies/v1/deployments/{deploymentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://semgrep.dev/api/policies/v1/deployments/{deploymentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://semgrep.dev/api/policies/v1/deployments/{deploymentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://semgrep.dev/api/policies/v1/deployments/{deploymentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://semgrep.dev/api/policies/v1/deployments/{deploymentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "policies": [
    {
      "id": "1",
      "name": "Global Policy",
      "slug": "global_policy",
      "productType": "PRODUCT_TYPE_SAST",
      "isDefault": true
    },
    {
      "id": "2",
      "name": "Semgrep test",
      "slug": "semgrep_test",
      "productType": "PRODUCT_TYPE_SAST",
      "isDefault": false
    },
    {
      "id": "3",
      "name": "Global Secrets Policy",
      "slug": "global_secrets_policy",
      "productType": "PRODUCT_TYPE_SECRETS",
      "isDefault": true
    }
  ]
}

This endpoint is experimental. It may change or be removed without notice and is not covered by API stability guarantees.

Authorizations

Authorization

string

header

required

Get access to data with your API token. Example header:

Authorization: Bearer 2991e2fb4b540fe75b8f90677b0b892b6314e4961cb001fe6eb452eee248a628

The token can be provisioned from the Tokens section in your Settings, and requires explicitly enabling Web API access.

Path Parameters

deploymentId

string<int64>

required

The unique numerical identifier for the deployment.

Example:

123

Response

200 - application/json

OK

policies

Policy · object[]

List of Policies associated with the given Deployment.

Show child attributes

Example:

[
  {
    "id": "1",
    "name": "Global Policy",
    "slug": "global_policy",
    "productType": "PRODUCT_TYPE_SAST",
    "isDefault": true
  },
  {
    "id": "2",
    "name": "Semgrep test",
    "slug": "semgrep_test",
    "productType": "PRODUCT_TYPE_SAST",
    "isDefault": false
  },
  {
    "id": "3",
    "name": "Global Secrets Policy",
    "slug": "global_secrets_policy",
    "productType": "PRODUCT_TYPE_SECRETS",
    "isDefault": true
  }
]

⌘I