Create

cURL

curl --request POST \
  --url https://us.infisical.com/api/v1/cert-manager/discovery-jobs \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "targetConfig": {
    "ipRanges": [
      "<string>"
    ],
    "domains": [
      "<string>"
    ],
    "ports": "443, 8443, 636, 993, 995",
    "connectionIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "searchFolderPaths": [
      "<string>"
    ],
    "skipFolderPaths": [],
    "maxFolderDepth": 8,
    "maxFileSizeKb": 512,
    "importStandaloneCaCertificates": false,
    "certificateStores": [
      "My",
      "WebHosting"
    ]
  },
  "description": "<string>",
  "discoveryType": "network",
  "isAutoScanEnabled": false,
  "scanIntervalDays": 183,
  "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://us.infisical.com/api/v1/cert-manager/discovery-jobs"

payload = {
    "name": "<string>",
    "targetConfig": {
        "ipRanges": ["<string>"],
        "domains": ["<string>"],
        "ports": "443, 8443, 636, 993, 995",
        "connectionIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
        "searchFolderPaths": ["<string>"],
        "skipFolderPaths": [],
        "maxFolderDepth": 8,
        "maxFileSizeKb": 512,
        "importStandaloneCaCertificates": False,
        "certificateStores": ["My", "WebHosting"]
    },
    "description": "<string>",
    "discoveryType": "network",
    "isAutoScanEnabled": False,
    "scanIntervalDays": 183,
    "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    targetConfig: {
      ipRanges: ['<string>'],
      domains: ['<string>'],
      ports: '443, 8443, 636, 993, 995',
      connectionIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
      searchFolderPaths: ['<string>'],
      skipFolderPaths: [],
      maxFolderDepth: 8,
      maxFileSizeKb: 512,
      importStandaloneCaCertificates: false,
      certificateStores: ['My', 'WebHosting']
    },
    description: '<string>',
    discoveryType: 'network',
    isAutoScanEnabled: false,
    scanIntervalDays: 183,
    gatewayId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    gatewayPoolId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://us.infisical.com/api/v1/cert-manager/discovery-jobs', 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://us.infisical.com/api/v1/cert-manager/discovery-jobs",
  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([
    'name' => '<string>',
    'targetConfig' => [
        'ipRanges' => [
                '<string>'
        ],
        'domains' => [
                '<string>'
        ],
        'ports' => '443, 8443, 636, 993, 995',
        'connectionIds' => [
                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ],
        'searchFolderPaths' => [
                '<string>'
        ],
        'skipFolderPaths' => [
                
        ],
        'maxFolderDepth' => 8,
        'maxFileSizeKb' => 512,
        'importStandaloneCaCertificates' => false,
        'certificateStores' => [
                'My',
                'WebHosting'
        ]
    ],
    'description' => '<string>',
    'discoveryType' => 'network',
    'isAutoScanEnabled' => false,
    'scanIntervalDays' => 183,
    'gatewayId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'gatewayPoolId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://us.infisical.com/api/v1/cert-manager/discovery-jobs"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"targetConfig\": {\n    \"ipRanges\": [\n      \"<string>\"\n    ],\n    \"domains\": [\n      \"<string>\"\n    ],\n    \"ports\": \"443, 8443, 636, 993, 995\",\n    \"connectionIds\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"searchFolderPaths\": [\n      \"<string>\"\n    ],\n    \"skipFolderPaths\": [],\n    \"maxFolderDepth\": 8,\n    \"maxFileSizeKb\": 512,\n    \"importStandaloneCaCertificates\": false,\n    \"certificateStores\": [\n      \"My\",\n      \"WebHosting\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"discoveryType\": \"network\",\n  \"isAutoScanEnabled\": false,\n  \"scanIntervalDays\": 183,\n  \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	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://us.infisical.com/api/v1/cert-manager/discovery-jobs")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"targetConfig\": {\n    \"ipRanges\": [\n      \"<string>\"\n    ],\n    \"domains\": [\n      \"<string>\"\n    ],\n    \"ports\": \"443, 8443, 636, 993, 995\",\n    \"connectionIds\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"searchFolderPaths\": [\n      \"<string>\"\n    ],\n    \"skipFolderPaths\": [],\n    \"maxFolderDepth\": 8,\n    \"maxFileSizeKb\": 512,\n    \"importStandaloneCaCertificates\": false,\n    \"certificateStores\": [\n      \"My\",\n      \"WebHosting\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"discoveryType\": \"network\",\n  \"isAutoScanEnabled\": false,\n  \"scanIntervalDays\": 183,\n  \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/cert-manager/discovery-jobs")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"targetConfig\": {\n    \"ipRanges\": [\n      \"<string>\"\n    ],\n    \"domains\": [\n      \"<string>\"\n    ],\n    \"ports\": \"443, 8443, 636, 993, 995\",\n    \"connectionIds\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"searchFolderPaths\": [\n      \"<string>\"\n    ],\n    \"skipFolderPaths\": [],\n    \"maxFolderDepth\": 8,\n    \"maxFileSizeKb\": 512,\n    \"importStandaloneCaCertificates\": false,\n    \"certificateStores\": [\n      \"My\",\n      \"WebHosting\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"discoveryType\": \"network\",\n  \"isAutoScanEnabled\": false,\n  \"scanIntervalDays\": 183,\n  \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "discoveryType": "network",
  "targetConfig": "<unknown>",
  "isAutoScanEnabled": false,
  "scanIntervalDays": 123,
  "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isActive": true,
  "lastScanStatus": "<string>",
  "lastScanJobId": "<string>",
  "lastScanMessage": "<string>",
  "lastScannedAt": "2023-11-07T05:31:56Z",
  "gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

POST

api

cert-manager

discovery-jobs

cURL

curl --request POST \
  --url https://us.infisical.com/api/v1/cert-manager/discovery-jobs \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "targetConfig": {
    "ipRanges": [
      "<string>"
    ],
    "domains": [
      "<string>"
    ],
    "ports": "443, 8443, 636, 993, 995",
    "connectionIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "searchFolderPaths": [
      "<string>"
    ],
    "skipFolderPaths": [],
    "maxFolderDepth": 8,
    "maxFileSizeKb": 512,
    "importStandaloneCaCertificates": false,
    "certificateStores": [
      "My",
      "WebHosting"
    ]
  },
  "description": "<string>",
  "discoveryType": "network",
  "isAutoScanEnabled": false,
  "scanIntervalDays": 183,
  "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://us.infisical.com/api/v1/cert-manager/discovery-jobs"

payload = {
    "name": "<string>",
    "targetConfig": {
        "ipRanges": ["<string>"],
        "domains": ["<string>"],
        "ports": "443, 8443, 636, 993, 995",
        "connectionIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
        "searchFolderPaths": ["<string>"],
        "skipFolderPaths": [],
        "maxFolderDepth": 8,
        "maxFileSizeKb": 512,
        "importStandaloneCaCertificates": False,
        "certificateStores": ["My", "WebHosting"]
    },
    "description": "<string>",
    "discoveryType": "network",
    "isAutoScanEnabled": False,
    "scanIntervalDays": 183,
    "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    targetConfig: {
      ipRanges: ['<string>'],
      domains: ['<string>'],
      ports: '443, 8443, 636, 993, 995',
      connectionIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
      searchFolderPaths: ['<string>'],
      skipFolderPaths: [],
      maxFolderDepth: 8,
      maxFileSizeKb: 512,
      importStandaloneCaCertificates: false,
      certificateStores: ['My', 'WebHosting']
    },
    description: '<string>',
    discoveryType: 'network',
    isAutoScanEnabled: false,
    scanIntervalDays: 183,
    gatewayId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    gatewayPoolId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://us.infisical.com/api/v1/cert-manager/discovery-jobs', 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://us.infisical.com/api/v1/cert-manager/discovery-jobs",
  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([
    'name' => '<string>',
    'targetConfig' => [
        'ipRanges' => [
                '<string>'
        ],
        'domains' => [
                '<string>'
        ],
        'ports' => '443, 8443, 636, 993, 995',
        'connectionIds' => [
                '3c90c3cc-0d44-4b50-8888-8dd25736052a'
        ],
        'searchFolderPaths' => [
                '<string>'
        ],
        'skipFolderPaths' => [
                
        ],
        'maxFolderDepth' => 8,
        'maxFileSizeKb' => 512,
        'importStandaloneCaCertificates' => false,
        'certificateStores' => [
                'My',
                'WebHosting'
        ]
    ],
    'description' => '<string>',
    'discoveryType' => 'network',
    'isAutoScanEnabled' => false,
    'scanIntervalDays' => 183,
    'gatewayId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'gatewayPoolId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://us.infisical.com/api/v1/cert-manager/discovery-jobs"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"targetConfig\": {\n    \"ipRanges\": [\n      \"<string>\"\n    ],\n    \"domains\": [\n      \"<string>\"\n    ],\n    \"ports\": \"443, 8443, 636, 993, 995\",\n    \"connectionIds\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"searchFolderPaths\": [\n      \"<string>\"\n    ],\n    \"skipFolderPaths\": [],\n    \"maxFolderDepth\": 8,\n    \"maxFileSizeKb\": 512,\n    \"importStandaloneCaCertificates\": false,\n    \"certificateStores\": [\n      \"My\",\n      \"WebHosting\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"discoveryType\": \"network\",\n  \"isAutoScanEnabled\": false,\n  \"scanIntervalDays\": 183,\n  \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

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

	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://us.infisical.com/api/v1/cert-manager/discovery-jobs")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"targetConfig\": {\n    \"ipRanges\": [\n      \"<string>\"\n    ],\n    \"domains\": [\n      \"<string>\"\n    ],\n    \"ports\": \"443, 8443, 636, 993, 995\",\n    \"connectionIds\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"searchFolderPaths\": [\n      \"<string>\"\n    ],\n    \"skipFolderPaths\": [],\n    \"maxFolderDepth\": 8,\n    \"maxFileSizeKb\": 512,\n    \"importStandaloneCaCertificates\": false,\n    \"certificateStores\": [\n      \"My\",\n      \"WebHosting\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"discoveryType\": \"network\",\n  \"isAutoScanEnabled\": false,\n  \"scanIntervalDays\": 183,\n  \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us.infisical.com/api/v1/cert-manager/discovery-jobs")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"targetConfig\": {\n    \"ipRanges\": [\n      \"<string>\"\n    ],\n    \"domains\": [\n      \"<string>\"\n    ],\n    \"ports\": \"443, 8443, 636, 993, 995\",\n    \"connectionIds\": [\n      \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    ],\n    \"searchFolderPaths\": [\n      \"<string>\"\n    ],\n    \"skipFolderPaths\": [],\n    \"maxFolderDepth\": 8,\n    \"maxFileSizeKb\": 512,\n    \"importStandaloneCaCertificates\": false,\n    \"certificateStores\": [\n      \"My\",\n      \"WebHosting\"\n    ]\n  },\n  \"description\": \"<string>\",\n  \"discoveryType\": \"network\",\n  \"isAutoScanEnabled\": false,\n  \"scanIntervalDays\": 183,\n  \"gatewayId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"gatewayPoolId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "discoveryType": "network",
  "targetConfig": "<unknown>",
  "isAutoScanEnabled": false,
  "scanIntervalDays": 123,
  "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isActive": true,
  "lastScanStatus": "<string>",
  "lastScanJobId": "<string>",
  "lastScanMessage": "<string>",
  "lastScannedAt": "2023-11-07T05:31:56Z",
  "gatewayPoolId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "reqId": "<string>",
  "statusCode": 400,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 401,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 403,
  "message": "<string>",
  "error": "<string>",
  "details": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 404,
  "message": "<string>",
  "error": "<string>"
}

{
  "reqId": "<string>",
  "statusCode": 422,
  "error": "<string>",
  "message": "<unknown>"
}

{
  "reqId": "<string>",
  "statusCode": 500,
  "message": "<string>",
  "error": "<string>"
}

Body

application/json

name

string

required

Name of the discovery configuration

Required string length: 1 - 100

targetConfig

object

required

Target configuration. Network jobs use domains, ipRanges and ports. Linux Server jobs use connectionIds, searchFolderPaths, skipFolderPaths, maxFolderDepth, maxFileSizeKb and importStandaloneCaCertificates. Windows Server jobs use connectionIds, certificateStores and importStandaloneCaCertificates.

Show child attributes

description

string

Description of the discovery configuration

Maximum string length: 255

discoveryType

enum<string>

default:network

Type of discovery scan

Available options:

network,

linux-server,

windows-server

isAutoScanEnabled

boolean

default:false

Enable automatic scheduled scans

scanIntervalDays

number

Interval in days between automatic scans

Required range: 1 <= x <= 365

gatewayId

string<uuid>

Gateway ID for scanning private networks

gatewayPoolId

string<uuid>

Gateway pool ID for scanning private networks

Response

Default Response

string<uuid>

required

name

string

required

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

description

string | null

discoveryType

string

default:network

targetConfig

any

isAutoScanEnabled

boolean

default:false

scanIntervalDays

number | null

gatewayId

string<uuid> | null

isActive

boolean

default:true

lastScanStatus

string | null

lastScanJobId

string | null

lastScanMessage

string | null

lastScannedAt

string<date-time> | null

gatewayPoolId

string<uuid> | null

Get started

Organization

Project

Shared

Identity auth

Secrets Management

Certificate Management

Secret sharing

Agent Vault

Key Management Service (KMS)

KMIP servers

Gateways

External migrations

Other

Body

Response