GET Salt

GET Salt

This API can show the following four fields from the current configuration of salt minion: master, master_type, retry_dns, and retry_dns_count.

Note that this API is only aware of these specific fields and will not recognize any additional fields in the /etc/salt/minion.d/master.conf file. Starting from version 8.18, any configuration details added directly to this file will not be recognized by the API.

Request
URI
GET
https://{api_host}/api/v2/salt
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Gets the current salt configuration.

Returns salt.get.response of type(s) application/json 
{
    "master": [
        "salt-master-1.licf.vmware.com",
        "salt-master-2.licf.vmware.com"
    ],
    "masterType": "str",
    "retryDns": 10,
    "retryDnsCount": 3
}

401
Operation doesn't return any data structure

440
Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json 
{
    "errorMessage": "Failed to process request."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/salt
On This Page
Salt Operations
GET
GET Salt
POST
POST Salt
DELETE
DELETE Salt