• Secrets Manager

manage secrets

get/secrets-manager/api/v1/host-secret/{host_id}

Read host secret metadata for all accounts

host_idstring

required

Responses

Response examples

Returns array of metadata of secrets for host

{
  "metadata": {
    "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "address": "string",
    "port": 123,
    "operating_system": "windows",
    "certificate_validation_options": "DISABLED",
    "winrm_host_certificate_trust_anchors": "string",
    "use_main_account": true,
    "main_account": "string",
    "winrm_main_account_password": "string",
    "password_policy_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "script_template_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
  },
  "accounts": [
    {
      "account": "string",
      "last_rotated": "2017-01-01T15:05:05Z",
      "last_error": "2017-01-01T15:05:05Z",
      "last_error_details": "string",
      "initial_password": "string"
    }
  ]
}
post/secrets-manager/api/v1/host-secret/{host_id}

secret definitions from admin via host store

metadataobject (metadata)

required

rotating password object

accountsarray
accountstring

required

username

last_rotatedstring

When last successful rotation. Added by backend

Format
date-time
Example
"2017-01-01T15:05:05Z"
last_errorstring

When last rotation error. Added by backend

Format
date-time
Example
"2017-01-01T15:05:05Z"
last_error_detailsstring

Last rotation error details. Added by backend

initial_passwordstring

initial password to store in vault to start rotation

Responses

Request examples

{
  "metadata": {
    "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "address": "string",
    "port": 123,
    "operating_system": "windows",
    "certificate_validation_options": "DISABLED",
    "winrm_host_certificate_trust_anchors": "string",
    "use_main_account": true,
    "main_account": "string",
    "winrm_main_account_password": "string",
    "password_policy_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "script_template_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
  },
  "accounts": [
    {
      "account": "string",
      "last_rotated": "2017-01-01T15:05:05Z",
      "last_error": "2017-01-01T15:05:05Z",
      "last_error_details": "string",
      "initial_password": "string"
    }
  ]
}

Response examples

Returns stored metadata + account array of secret for host

{
  "metadata": {
    "host_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "access_group_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "address": "string",
    "port": 123,
    "operating_system": "windows",
    "certificate_validation_options": "DISABLED",
    "winrm_host_certificate_trust_anchors": "string",
    "use_main_account": true,
    "main_account": "string",
    "winrm_main_account_password": "string",
    "password_policy_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "script_template_id": "5bf77342-221c-11ee-be56-0242ac120002",
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
  },
  "accounts": [
    {
      "account": "string",
      "last_rotated": "2017-01-01T15:05:05Z",
      "last_error": "2017-01-01T15:05:05Z",
      "last_error_details": "string",
      "initial_password": "string"
    }
  ]
}
delete/secrets-manager/api/v1/host-secret/{host_id}

delete secret from admin via host store

host_idstring

required

Responses

Response examples

Host secret deleted

Empty response

Was this page helpful?