Site

Site Scan Credential

Updates the specified site credential.

put/api/3/sites/{id}/site_credentials/{credentialId}

Request

Base URL
https://<host>:<port>
Auth
none declared
TypeScript
https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/sites/:id/site_credentials/:credentialId/put.ts
A function with typed inputs. Its response is checked against the schema.

credentialIdinteger required

The identifier of the credential.

Example:17

The identifier of the site credential.

idinteger required

The identifier of the site.

descriptionstring

The description of the credential.

enabledboolean

Whether this credential is enabled

hostRestrictionstring

The host name or IP address that you want to restrict the credentials to.

idinteger

The identifier of the credential.

namestring required

The name of the credential.

portRestrictioninteger

Further restricts the credential to attempt to authenticate on a specific port.

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ]
}