Getting started

Asset Management v2 API

Asset Discovery API

Vulnerability Management API

Asset Tagging v1 API

Mission v2 API

Assessment Service v1 API

Platform v1 API

Query API v1

Change part of the login IP allowlist policy

Change part of the policy, leaving everything else as it is. At least one of mode and entries must be supplied. Entries named under add are allowed and entries named under remove are revoked, and both accept an IP address or a CIDR block. Adding an entry that is already present changes nothing, and an entry named under both is kept. Enforcement requires at least one entry, and the address the request comes from does not need to be covered. Requires admin privileges.

PATCH

login_ip_allowlist

curl --request PATCH \
  --url https://api.synack.com/v1/login_ip_allowlist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entries": {
    "add": [
      "198.51.100.0/24"
    ],
    "remove": [
      "203.0.113.10"
    ]
  }
}
'

import requests

url = "https://api.synack.com/v1/login_ip_allowlist"

payload = { "entries": {
        "add": ["198.51.100.0/24"],
        "remove": ["203.0.113.10"]
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({entries: {add: ['198.51.100.0/24'], remove: ['203.0.113.10']}})
};

fetch('https://api.synack.com/v1/login_ip_allowlist', 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://api.synack.com/v1/login_ip_allowlist",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'entries' => [
        'add' => [
                '198.51.100.0/24'
        ],
        'remove' => [
                '203.0.113.10'
        ]
    ]
  ]),
  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://api.synack.com/v1/login_ip_allowlist"

	payload := strings.NewReader("{\n  \"entries\": {\n    \"add\": [\n      \"198.51.100.0/24\"\n    ],\n    \"remove\": [\n      \"203.0.113.10\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.synack.com/v1/login_ip_allowlist")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entries\": {\n    \"add\": [\n      \"198.51.100.0/24\"\n    ],\n    \"remove\": [\n      \"203.0.113.10\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synack.com/v1/login_ip_allowlist")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entries\": {\n    \"add\": [\n      \"198.51.100.0/24\"\n    ],\n    \"remove\": [\n      \"203.0.113.10\"\n    ]\n  }\n}"

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

{
  "mode": "disabled",
  "entries": [
    "198.51.100.0/24"
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

mode

enum<string>

Whether logins from outside the allowlist are refused

Available options:

disabled,

enforced

entries

object

Networks to allow and networks to revoke

Show child attributes

Response

The stored login IP allowlist policy

mode

enum<string>

required

Whether logins from outside the allowlist are refused. Entries are kept while the policy is disabled.

Available options:

disabled,

enforced

entries

string[]

required

Networks allowed to authenticate. A single host is returned as a bare address, a wider range in CIDR notation.

Maximum array length: 1000

Change part of the login IP allowlist policy

curl --request PATCH \
  --url https://api.synack.com/v1/login_ip_allowlist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entries": {
    "add": [
      "198.51.100.0/24"
    ],
    "remove": [
      "203.0.113.10"
    ]
  }
}
'

import requests

url = "https://api.synack.com/v1/login_ip_allowlist"

payload = { "entries": {
        "add": ["198.51.100.0/24"],
        "remove": ["203.0.113.10"]
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({entries: {add: ['198.51.100.0/24'], remove: ['203.0.113.10']}})
};

fetch('https://api.synack.com/v1/login_ip_allowlist', 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://api.synack.com/v1/login_ip_allowlist",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'entries' => [
        'add' => [
                '198.51.100.0/24'
        ],
        'remove' => [
                '203.0.113.10'
        ]
    ]
  ]),
  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://api.synack.com/v1/login_ip_allowlist"

	payload := strings.NewReader("{\n  \"entries\": {\n    \"add\": [\n      \"198.51.100.0/24\"\n    ],\n    \"remove\": [\n      \"203.0.113.10\"\n    ]\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.synack.com/v1/login_ip_allowlist")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entries\": {\n    \"add\": [\n      \"198.51.100.0/24\"\n    ],\n    \"remove\": [\n      \"203.0.113.10\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.synack.com/v1/login_ip_allowlist")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entries\": {\n    \"add\": [\n      \"198.51.100.0/24\"\n    ],\n    \"remove\": [\n      \"203.0.113.10\"\n    ]\n  }\n}"

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

{
  "mode": "disabled",
  "entries": [
    "198.51.100.0/24"
  ]
}