Manage Credential Set by ID

Updates, gets, and deletes a credential set by ID.

Gets credential set details by ID.

Path Parameters

  • credentialSetIdstringrequired

    Unique Identifier (UUID) the credential set

  • clientIdstringrequired

    Describes the clientId

Responses

  • uniqueIdstring

  • namestring

    Credential set name.

  • secureboolean

  • portinteger

  • snmpVersionstring

  • descriptionstring

  • autoEnableModeboolean

  • universalboolean

  • spSecureboolean

  • spPortinteger

  • timeoutMsinteger

    Time out, represented in milliseconds.

  • credentialTypestring

    Credential type.

    Enum:
    AWSSNMPWINDOWSVNCVMWARE
  • domainName string

    Domain name.

  • userNamestring

    Credentials of user.

  • passwordstring

    Credentials of user.

  • transportTypestring

    Transport layer type.

    Enum:
    HTTPSNMPSSHTELNET
  • communitystring

  • spUserNamestring

  • spPasswordstring

  • spAuthScopestring

  • fileAuthScopestring

  • esxUserNamestring

  • esxPasswordstring

  • spNameSpacestring

  • authProtocolstring

  • encryptPasswordstring

  • snmpContextstring

  • securityLevelstring

    Security level.

    Enum:
    NOAUTHNOPRIVAUTHPRIVAUTHNOPRIVBASICOAUTH2
  • securityNamestring

  • apiEndPointstring

  • accountIdstring

  • accountNamestring

  • accountKeystring

  • managementCertificatestring

  • managementCertificatePassphrasestring

  • sshCredentialTypestring

    SSH credential type.

    Enum:
    PASSWORDKEYPAIR
  • collectorTypestring

    Collector type.

    Enum:
    APICLIAPIANDCLISMISUNKNOWN
  • assignedDevicesarray

  • enablePasswordstring

  • syncDataTSinteger

  • assignedUsersarray

  • assignedDeviceGroupsarray

  • clientIdnumberdeprecated

Loading Examples...

Updates a credential set by ID.

Path Parameters

  • credentialSetIdstringrequired

    Unique Identifier (UUID) the credential set

  • clientIdstringrequired

    Describes the clientId

Request Body

application/json

  • uniqueIdstring

  • namestring

    Credential set name.

  • secureboolean

  • portinteger

  • snmpVersionstring

  • descriptionstring

  • autoEnableModeboolean

  • universalboolean

  • spSecureboolean

  • spPortinteger

  • timeoutMsinteger

    Time out, represented in milliseconds.

  • credentialTypestring

    Credential type.

    Enum:
    AWSSNMPWINDOWSVNCVMWARE
  • domainName string

    Domain name.

  • userNamestring

    Credentials of user.

  • passwordstring

    Credentials of user.

  • transportTypestring

    Transport layer type.

    Enum:
    HTTPSNMPSSHTELNET
  • communitystring

  • spUserNamestring

  • spPasswordstring

  • spAuthScopestring

  • fileAuthScopestring

  • esxUserNamestring

  • esxPasswordstring

  • spNameSpacestring

  • authProtocolstring

  • encryptPasswordstring

  • snmpContextstring

  • securityLevelstring

    Security level.

    Enum:
    NOAUTHNOPRIVAUTHPRIVAUTHNOPRIVBASICOAUTH2
  • securityNamestring

  • apiEndPointstring

  • accountIdstring

  • accountNamestring

  • accountKeystring

  • managementCertificatestring

  • managementCertificatePassphrasestring

  • sshCredentialTypestring

    SSH credential type.

    Enum:
    PASSWORDKEYPAIR
  • collectorTypestring

    Collector type.

    Enum:
    APICLIAPIANDCLISMISUNKNOWN
  • assignedDevicesarray

  • enablePasswordstring

  • syncDataTSinteger

  • assignedUsersarray

  • assignedDeviceGroupsarray

  • clientIdnumberdeprecated

Loading Examples...

Responses

  • uniqueIdstring

  • namestring

    Credential set name.

  • secureboolean

  • portinteger

  • snmpVersionstring

  • descriptionstring

  • autoEnableModeboolean

  • universalboolean

  • spSecureboolean

  • spPortinteger

  • timeoutMsinteger

    Time out, represented in milliseconds.

  • credentialTypestring

    Credential type.

    Enum:
    AWSSNMPWINDOWSVNCVMWARE
  • domainName string

    Domain name.

  • userNamestring

    Credentials of user.

  • passwordstring

    Credentials of user.

  • transportTypestring

    Transport layer type.

    Enum:
    HTTPSNMPSSHTELNET
  • communitystring

  • spUserNamestring

  • spPasswordstring

  • spAuthScopestring

  • fileAuthScopestring

  • esxUserNamestring

  • esxPasswordstring

  • spNameSpacestring

  • authProtocolstring

  • encryptPasswordstring

  • snmpContextstring

  • securityLevelstring

    Security level.

    Enum:
    NOAUTHNOPRIVAUTHPRIVAUTHNOPRIVBASICOAUTH2
  • securityNamestring

  • apiEndPointstring

  • accountIdstring

  • accountNamestring

  • accountKeystring

  • managementCertificatestring

  • managementCertificatePassphrasestring

  • sshCredentialTypestring

    SSH credential type.

    Enum:
    PASSWORDKEYPAIR
  • collectorTypestring

    Collector type.

    Enum:
    APICLIAPIANDCLISMISUNKNOWN
  • assignedDevicesarray

  • enablePasswordstring

  • syncDataTSinteger

  • assignedUsersarray

  • assignedDeviceGroupsarray

  • clientIdnumberdeprecated

Loading Examples...

Deletes a credential set.

Path Parameters

  • credentialSetIdstringrequired

    Unique Identifier (UUID) the credential set

  • clientIdstringrequired

    Describes the clientId

Responses

200OK