Get Seeds in a Seed Group

GET

organizations

{organizationUid}

seed-groups

{seedGroupUid}

seeds

cURL

curl --request GET \
  --url https://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds"

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

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

print(response.text)

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

fetch('https://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds', 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://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds",
  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://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds"

	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))

}

HttpResponse<String> response = Unirest.get("https://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds")

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

{
  "seeds": [
    {
      "name": "<string>",
      "seedType": "ip",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "uid": "<string>",
      "seedGroupUid": "<string>",
      "organizationUid": "<string>",
      "tags": [
        "<string>"
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 305,
  "detail": "<string>",
  "instance": "<string>",
  "failedValidation": [
    {
      "message": "<string>",
      "property": "<string>",
      "value": "<string>"
    }
  ],
  "failedValidations": [
    {
      "index": 123,
      "failedValidation": [
        {
          "message": "<string>",
          "property": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "maxBatchSize": 123,
  "batchSize": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 305,
  "detail": "<string>",
  "instance": "<string>",
  "failedValidation": [
    {
      "message": "<string>",
      "property": "<string>",
      "value": "<string>"
    }
  ],
  "failedValidations": [
    {
      "index": 123,
      "failedValidation": [
        {
          "message": "<string>",
          "property": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "maxBatchSize": 123,
  "batchSize": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 305,
  "detail": "<string>",
  "instance": "<string>",
  "failedValidation": [
    {
      "message": "<string>",
      "property": "<string>",
      "value": "<string>"
    }
  ],
  "failedValidations": [
    {
      "index": 123,
      "failedValidation": [
        {
          "message": "<string>",
          "property": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "maxBatchSize": 123,
  "batchSize": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 305,
  "detail": "<string>",
  "instance": "<string>",
  "failedValidation": [
    {
      "message": "<string>",
      "property": "<string>",
      "value": "<string>"
    }
  ],
  "failedValidations": [
    {
      "index": 123,
      "failedValidation": [
        {
          "message": "<string>",
          "property": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "maxBatchSize": 123,
  "batchSize": 123
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowImplicit

Authorization URL: login.synack.com

Scopes3

assetdiscovery_or

Grants organization-level to read seed groups and seeds.

assetdiscovery_gr

Grants global-level to read seed groups and seeds.

assetdiscovery_lr

Grants listing-level to read seed groups and seeds.

Path Parameters

organizationUid

string

required

Unique identifier for an organization group. Unique identifier for an organization.

Pattern: ^[-_0-9a-z]{1,50}

seedGroupUid

string

required

Unique identifier for a seed group.

Pattern: ^[0-9a-f]{12}

Query Parameters

perPage

integer<int32>

Requested page size for pagination. A server-selected default of 100 will be used when no perPage is requested via query parameter.

Required range: 1 <= x <= 5000

page

integer<int32>

Page to retrieve in paginated response. A server-selected default of 1 will be used when no page is requested via query parameter.

Required range: x >= 1

sort

enum<string>

default:name

Optional property to sort results by.

Available options:

name,

seedType,

createdAt,

updatedAt,

createdBy

sortDir

enum<string>

default:asc

Direction of sort-order for items in the response.

Available options:

asc,

desc

string

Optional query parameter for a search string that will be used to match within seed name.

seedType

enum<string>[]

Filter the response to include only seeds with a seed type.

Available options:

ip,

domain,

cidr,

ip_range

tag

string[]

Optional query parameter for a tag that will be used to filter seeds.

Response

Paginated seeds.

seeds

object[]

Show child attributes

cURL

curl --request GET \
  --url https://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds"

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

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

print(response.text)

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

fetch('https://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds', 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://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds",
  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://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds"

	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))

}

HttpResponse<String> response = Unirest.get("https://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://client.synack.com/api/asset-discovery/v1/organizations/{organizationUid}/seed-groups/{seedGroupUid}/seeds")

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

{
  "seeds": [
    {
      "name": "<string>",
      "seedType": "ip",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "uid": "<string>",
      "seedGroupUid": "<string>",
      "organizationUid": "<string>",
      "tags": [
        "<string>"
      ],
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedBy": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 305,
  "detail": "<string>",
  "instance": "<string>",
  "failedValidation": [
    {
      "message": "<string>",
      "property": "<string>",
      "value": "<string>"
    }
  ],
  "failedValidations": [
    {
      "index": 123,
      "failedValidation": [
        {
          "message": "<string>",
          "property": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "maxBatchSize": 123,
  "batchSize": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 305,
  "detail": "<string>",
  "instance": "<string>",
  "failedValidation": [
    {
      "message": "<string>",
      "property": "<string>",
      "value": "<string>"
    }
  ],
  "failedValidations": [
    {
      "index": 123,
      "failedValidation": [
        {
          "message": "<string>",
          "property": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "maxBatchSize": 123,
  "batchSize": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 305,
  "detail": "<string>",
  "instance": "<string>",
  "failedValidation": [
    {
      "message": "<string>",
      "property": "<string>",
      "value": "<string>"
    }
  ],
  "failedValidations": [
    {
      "index": 123,
      "failedValidation": [
        {
          "message": "<string>",
          "property": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "maxBatchSize": 123,
  "batchSize": 123
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 305,
  "detail": "<string>",
  "instance": "<string>",
  "failedValidation": [
    {
      "message": "<string>",
      "property": "<string>",
      "value": "<string>"
    }
  ],
  "failedValidations": [
    {
      "index": 123,
      "failedValidation": [
        {
          "message": "<string>",
          "property": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "maxBatchSize": 123,
  "batchSize": 123
}

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

Authorizations

Path Parameters

Query Parameters

Response