List projects

curl --request POST \
  --url https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": 100,
  "pageToken": "",
  "filter": {
    "assignedToTeams": false,
    "names": [
      "foo/bar",
      "baz/qux"
    ],
    "statuses": [
      "PROJECT_STATUS_ARCHIVED",
      "PROJECT_STATUS_UNINITIALIZED"
    ]
  }
}
'

import requests

url = "https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list"

payload = {
    "pageSize": 100,
    "pageToken": "",
    "filter": {
        "assignedToTeams": False,
        "names": ["foo/bar", "baz/qux"],
        "statuses": ["PROJECT_STATUS_ARCHIVED", "PROJECT_STATUS_UNINITIALIZED"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pageSize: 100,
    pageToken: '',
    filter: {
      assignedToTeams: false,
      names: ['foo/bar', 'baz/qux'],
      statuses: ['PROJECT_STATUS_ARCHIVED', 'PROJECT_STATUS_UNINITIALIZED']
    }
  })
};

fetch('https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list', 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/v2/deployments/{deploymentId}/projects/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pageSize' => 100,
    'pageToken' => '',
    'filter' => [
        'assignedToTeams' => false,
        'names' => [
                'foo/bar',
                'baz/qux'
        ],
        'statuses' => [
                'PROJECT_STATUS_ARCHIVED',
                'PROJECT_STATUS_UNINITIALIZED'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list"

	payload := strings.NewReader("{\n  \"pageSize\": 100,\n  \"pageToken\": \"\",\n  \"filter\": {\n    \"assignedToTeams\": false,\n    \"names\": [\n      \"foo/bar\",\n      \"baz/qux\"\n    ],\n    \"statuses\": [\n      \"PROJECT_STATUS_ARCHIVED\",\n      \"PROJECT_STATUS_UNINITIALIZED\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pageSize\": 100,\n  \"pageToken\": \"\",\n  \"filter\": {\n    \"assignedToTeams\": false,\n    \"names\": [\n      \"foo/bar\",\n      \"baz/qux\"\n    ],\n    \"statuses\": [\n      \"PROJECT_STATUS_ARCHIVED\",\n      \"PROJECT_STATUS_UNINITIALIZED\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pageSize\": 100,\n  \"pageToken\": \"\",\n  \"filter\": {\n    \"assignedToTeams\": false,\n    \"names\": [\n      \"foo/bar\",\n      \"baz/qux\"\n    ],\n    \"statuses\": [\n      \"PROJECT_STATUS_ARCHIVED\",\n      \"PROJECT_STATUS_UNINITIALIZED\"\n    ]\n  }\n}"

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

{
  "projects": [
    {
      "id": 555,
      "name": "foo/bar",
      "createTime": "2021-01-01T01:23:00.000Z",
      "tags": [
        "backend",
        "python"
      ],
      "latestScanId": 4356445,
      "url": "https://github.com/foo/bar",
      "primaryBranchId": 12345,
      "defaultBranchId": 67890,
      "scmType": "SCM_TYPE_GITHUB"
    }
  ],
  "pageToken": "abc123"
}

POST

api

deployments

{deploymentId}

projects

list

List projects

curl --request POST \
  --url https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": 100,
  "pageToken": "",
  "filter": {
    "assignedToTeams": false,
    "names": [
      "foo/bar",
      "baz/qux"
    ],
    "statuses": [
      "PROJECT_STATUS_ARCHIVED",
      "PROJECT_STATUS_UNINITIALIZED"
    ]
  }
}
'

import requests

url = "https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list"

payload = {
    "pageSize": 100,
    "pageToken": "",
    "filter": {
        "assignedToTeams": False,
        "names": ["foo/bar", "baz/qux"],
        "statuses": ["PROJECT_STATUS_ARCHIVED", "PROJECT_STATUS_UNINITIALIZED"]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pageSize: 100,
    pageToken: '',
    filter: {
      assignedToTeams: false,
      names: ['foo/bar', 'baz/qux'],
      statuses: ['PROJECT_STATUS_ARCHIVED', 'PROJECT_STATUS_UNINITIALIZED']
    }
  })
};

fetch('https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list', 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/v2/deployments/{deploymentId}/projects/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pageSize' => 100,
    'pageToken' => '',
    'filter' => [
        'assignedToTeams' => false,
        'names' => [
                'foo/bar',
                'baz/qux'
        ],
        'statuses' => [
                'PROJECT_STATUS_ARCHIVED',
                'PROJECT_STATUS_UNINITIALIZED'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list"

	payload := strings.NewReader("{\n  \"pageSize\": 100,\n  \"pageToken\": \"\",\n  \"filter\": {\n    \"assignedToTeams\": false,\n    \"names\": [\n      \"foo/bar\",\n      \"baz/qux\"\n    ],\n    \"statuses\": [\n      \"PROJECT_STATUS_ARCHIVED\",\n      \"PROJECT_STATUS_UNINITIALIZED\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pageSize\": 100,\n  \"pageToken\": \"\",\n  \"filter\": {\n    \"assignedToTeams\": false,\n    \"names\": [\n      \"foo/bar\",\n      \"baz/qux\"\n    ],\n    \"statuses\": [\n      \"PROJECT_STATUS_ARCHIVED\",\n      \"PROJECT_STATUS_UNINITIALIZED\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://semgrep.dev/api/v2/deployments/{deploymentId}/projects/list")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pageSize\": 100,\n  \"pageToken\": \"\",\n  \"filter\": {\n    \"assignedToTeams\": false,\n    \"names\": [\n      \"foo/bar\",\n      \"baz/qux\"\n    ],\n    \"statuses\": [\n      \"PROJECT_STATUS_ARCHIVED\",\n      \"PROJECT_STATUS_UNINITIALIZED\"\n    ]\n  }\n}"

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

{
  "projects": [
    {
      "id": 555,
      "name": "foo/bar",
      "createTime": "2021-01-01T01:23:00.000Z",
      "tags": [
        "backend",
        "python"
      ],
      "latestScanId": 4356445,
      "url": "https://github.com/foo/bar",
      "primaryBranchId": 12345,
      "defaultBranchId": 67890,
      "scmType": "SCM_TYPE_GITHUB"
    }
  ],
  "pageToken": "abc123"
}

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

required

Your deployment ID.

Body

application/json

pageSize

integer<int64>

default:100

Maximum number of projects to return in a single page.

Required range: 1 <= x <= 3000

Example:

100

pageToken

string

default:""

Opaque cursor used for pagination. If not provided the first page will be returned.

Example:

""

filter

Projects Filter · object

Optionally apply filters to which projects should be returned.

Show child attributes

Response

200 - application/json

projects

Project · object[]

The list of projects.

Show child attributes

pageToken

string

An opaque cursor used to paginate through the results.

Example:

"abc123"

⌘I

Overview

Endpoints

List projects

Authorizations

Path Parameters

Body

Response