Search key alias name

Search if alias name is available or not to create new key alias.

Request

GET /GmaApi/apikeys/search/{alias}

Example cURL request

curl -X GET "https://hostname/GmaApi/apikeys/search/jeanAPI" -v -H "Authorization: Bearer 170ebd6c-f930-4561-afb6-8e0560014f50" -H "Accept: application/json" -H "Content-Type: application/json" -k

Resource URI

https://hostname/GmaApi/apikeys/search/{alias}

Authorization header

For information about obtaining an access token, see Request an access token.

Request parameter

Table 1. Request path parameters
Parameter	Type	Required	Description
alias	String	Yes	The name of the key alias to search for the availability. Note: Only underscore(_)and hyphen (-)as a special character is valid attribute name

Example response

{
    "available": true,
    "status": {
        "success": true,
        "apiError": false,
        "message": "",
        "errors": {}
    }
}

Response parameter

Table 2. Response parameters
Parameter	Description
status	Returns whether the request was successful. Returns an error when the request is unsuccessful. For more information about errors, see Errors.
avaiable	If available=true, it means alias name is available to create new API key. If available=false, it means alias name already exist and cannot be created again.