Update directory

patch

https://{customer}.tenable.ad/api/infrastructures/{infrastructureId}/directories/{id}

Updates the specified directory, including the connection details for its primary domain controller.

Requires one of the following license types: ioa, ioaPreview, or ioe. See License Types.

Requires the Edit permission on the Domains entity (edit:directory). See Identity Exposure Permissions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

infrastructureId

string

required

^[0-9]+$

Specifies the ID of the infrastructure (forest).

string

required

^[0-9]+$

Specifies the ID of the directory.

Body Params

Validates the PATCH /directory/:id request

name

string

Specifies the name of the domain.

string

Specifies the IP address or hostname of the domain's primary domain controller.

type

string

enum

Specifies the type of directory.

Allowed:

ldapPort

integer

Specifies the LDAP port of the primary domain controller.

globalCatalogPort

integer

Specifies the global catalog port of the primary domain controller.

smbPort

integer

Specifies the SMB port of the primary domain controller.

dns

string | null

Specifies the fully qualified domain name (FQDN) of the domain.

sensitiveDataCollectionIsEnabled

boolean

Specifies whether to collect privileged data from the domain for advanced security analysis.

relayId

Specifies the ID of the relay that connects to the domain controller. Required in SaaS deployments.

Responses

401

Returned if the API key specified in your request is invalid.

404

Returned if the specified directory could not be found.

500

Returned if an internal error occurred.

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returned if the directory was updated successfully.