Fetch machine tags list

GET 
/api/v1/machine-tags

This API endpoint retrieve a list of tags associated with machines for an account.

Request

Query Parameters

allParams objectrequired

allParams - pageNo, pageSize, sortBy, sortDirection, key, value etc.

Responses

200

Success response

application/json

Schema

Schema

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

payload

object

Schema for paginated response

content

object[]

Array [

machineId string

key string

value string

]

totalPages int32

totalRecordCount int64

pageSize int32

Example (from schema)

{
  "success": true,
  "message": "string",
  "status": "string",
  "statusCode": 0,
  "errorCode": "string",
  "subErrors": [
    {}
  ],
  "payload": {
    "content": [
      {
        "machineId": "string",
        "key": "string",
        "value": "string"
      }
    ],
    "totalPages": 0,
    "totalRecordCount": 0,
    "pageSize": 0
  }
}

Fetch machine tags list example

Fetch machine tags list response example

{
  "success": true,
  "message": "Machine tags fetched successfully",
  "status": "OK",
  "statusCode": 200,
  "errorCode": "",
  "subErrors": [
    {}
  ],
  "payload": {
    "content": [
      {
        "machineId": "xxb63e2aaedx-xxxx-123",
        "key": "test",
        "value": "testValue"
      }
    ],
    "totalPages": 2,
    "totalRecordCount": 2,
    "pageSize": 1
  }
}

Loading...