Update ruleboard overview

curl --request PUT \
  --url https://semgrep.dev/api/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Custom Policy",
  "assigned_repos": [
    "<string>"
  ]
}
'

import requests

url = "https://semgrep.dev/api/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview"

payload = {
    "name": "My Custom Policy",
    "assigned_repos": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'My Custom Policy', assigned_repos: ['<string>']})
};

fetch('https://semgrep.dev/api/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview', 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/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Custom Policy',
    'assigned_repos' => [
        '<string>'
    ]
  ]),
  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/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview"

	payload := strings.NewReader("{\n  \"name\": \"My Custom Policy\",\n  \"assigned_repos\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://semgrep.dev/api/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Custom Policy\",\n  \"assigned_repos\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://semgrep.dev/api/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Custom Policy\",\n  \"assigned_repos\": [\n    \"<string>\"\n  ]\n}"

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

{
  "name": "<string>",
  "slug": "<string>",
  "default": true,
  "assigned_repos": [
    "<string>"
  ]
}

PUT

api

agent

deployments

{deploymentId}

ruleboards

{ruleboardSlug}

overview

Update ruleboard overview

curl --request PUT \
  --url https://semgrep.dev/api/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My Custom Policy",
  "assigned_repos": [
    "<string>"
  ]
}
'

import requests

url = "https://semgrep.dev/api/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview"

payload = {
    "name": "My Custom Policy",
    "assigned_repos": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'My Custom Policy', assigned_repos: ['<string>']})
};

fetch('https://semgrep.dev/api/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview', 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/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'My Custom Policy',
    'assigned_repos' => [
        '<string>'
    ]
  ]),
  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/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview"

	payload := strings.NewReader("{\n  \"name\": \"My Custom Policy\",\n  \"assigned_repos\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://semgrep.dev/api/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"My Custom Policy\",\n  \"assigned_repos\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://semgrep.dev/api/agent/deployments/{deploymentId}/ruleboards/{ruleboardSlug}/overview")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"My Custom Policy\",\n  \"assigned_repos\": [\n    \"<string>\"\n  ]\n}"

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

{
  "name": "<string>",
  "slug": "<string>",
  "default": true,
  "assigned_repos": [
    "<string>"
  ]
}

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 of your deployment. Can be found via the Deployments Service or in your Settings in the web UI.

Example:

1234

ruleboardSlug

string

required

Slug of the ruleboard as it appears in the URL.

Body

application/json

name

string

Name of the ruleboard.

Example:

"My Custom Policy"

assigned_repos

string[]

List of projects associated with the ruleboard, as strings.

Response

200 - application/json

name

string

slug

string

default

boolean

assigned_repos

string[]

⌘I

Overview

Endpoints

Update ruleboard overview

Authorizations

Path Parameters

Body

Response