Getting A staged director's properties
Fetch director, IaaS, and security properties.
Note: The property address field under syslog_configuration can be either a hostname or an IP address.
Note: The property opentsdb_ip field under director_configuration maps to the Bosh Health Monitor IP Address.
Note: If there are multiple Iaas Configurations, the iaas_configuration key is omitted from the response.
When redact is true the following properties are omitted from the response:
- director_configuration.s3_blobstore_options.access_key
- director_configuration.s3_blobstore_options.secret_key
- director_configuration.gcs_blobstore_options.service_account_key
- director_configuration.external_database_options.password
- director_configuration.hm_pager_duty_options.service_key
- director_configuration.hm_emailer_options.smtp_password
- director_configuration.providers[*].partition_password
- director_configuration.providers[*].client_key
Request
URI
GET
https://{api_host}/api/v0/staged/director/properties
COPY
Query Parameters
boolean
redact
Optional
(Optional) If set to 'false', the response will include IaaS-specific secrets.
Responses
200
OK
Returns
DirectorProperties
of type(s)
application/json
"DirectorProperties Object"
iaas_configuration
Optional
iaas_configuration
director_configuration
Optional
director_configuration
dns_configuration
Optional
dns_configuration
security_configuration
Optional
security_configuration
syslog_configuration
Optional
syslog_configuration
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/v0/staged/director/properties