Check alias is already used or not

GET 
/api/v1/machines/check-alias-inuse

This API endpoint checks if the provided alias is already in use within a machine for an account or is available to use.

Request

Query Parameters

alias stringrequired

The alias - machine alias

Responses

200

Success response

application/json

Schema

Schema

success boolean
message string
status string
statusCode int32
errorCode string
subErrors object[]
payload boolean

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": true
}

Check alias in use example

Check alias in use response example

{
  "success": true,
  "message": "Machine alias available",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": true
}

Loading...