Get custom attribute types and values of a tenant

This endpoint is used to search for custom attribute types and their respective values.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/customAttributes/search

Sample URLs

https://{api-url}/api/v2/tenants/client_93/customAttributes/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id
https://{api-url}/api/v2/tenants/msp_92/customAttributes/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id

Parameters

All parameters are optional:

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}id

Sample response

{
	"results": [{
			"id": 63,
			"name": "custom_attr_from_API_test_1",
			"description": "custom_attr_from_API_test_1_update",
			"customAttributeValues": [{
					"id": 396,
					"value": "custom_attr_from_API_test_1_value",
					"description": "desc_custom_attr_from_API_test_1_update_1"
				},
				{
					"id": 399,
					"value": "custom_attr_from_API_test_2_value",
					"description": "custom_attr_from_API_test_2_value_description"
				}
			],
			"organization": {
				"id": 93,
				"uniqueId": "client_93",
				"name": "Brocade Lab",
				"activated": true
			}
		},
		{
			"id": 61,
			"name": "test case",
			"description": "test case",
			"customAttributeValues": [{
					"id": 393,
					"value": "custom attribute values",
					"description": "test case example"
				},
				{
					"id": 392,
					"value": "value",
					"description": "test case"
				},
				{
					"id": 394,
					"value": "value for test case",
					"description": "test case value"
				}
			],
			"organization": {
				"id": 93,
				"uniqueId": "client_93",
				"name": "Brocade Lab",
				"activated": true
			}
		},
		{
			"id": 60,
			"name": "Test",
			"customAttributeValues": [{
				"id": 387,
				"value": "ELB"
			}],
			"organization": {
				"id": 93,
				"uniqueId": "client_93",
				"name": "Brocade Lab",
				"activated": true
			}
		},
		{
			"id": 59,
			"name": "Test-Tag-Key1",
			"customAttributeValues": [{
				"id": 375,
				"value": "Test-Tag-Key-Value1"
			}],
			"organization": {
				"id": 93,
				"uniqueId": "client_93",
				"name": "Brocade Lab",
				"activated": true
			}
		},
		{
			"id": 58,
			"name": "aws:autoscaling:groupName",
			"customAttributeValues": [{
					"id": 373,
					"value": "acme-web-as-group"
				},
				{
					"id": 385,
					"value": "opsramp-autoscale-webapp"
				}
			],
			"organization": {
				"id": 93,
				"uniqueId": "client_93",
				"name": "Brocade Lab",
				"activated": true
			}
		},
		{
			"id": 57,
			"name": "Name",
			"customAttributeValues": [{
					"id": 382,
					"value": "acme-ecomm-aws-api1"
				},
				{
					"id": 367,
					"value": "acme-ecomm-aws-api2"
				},
				{
					"id": 364,
					"value": "acme-ecomm-aws-api3"
				},
				{
					"id": 365,
					"value": "acme-ecomm-aws-cache1"
				},
				{
					"id": 381,
					"value": "acme-ecomm-aws-cache2"
				}
			],
			"organization": {
				"id": 93,
				"uniqueId": "client_93",
				"name": "Brocade Lab",
				"activated": true
			}
		}
	],
	"totalResults": 6,
	"orderBy": "tag.id",
	"pageNo": 1,
	"pageSize": 2,
	"totalPages": 3,
	"nextPage": true,
	"nextPageNo": 2,
	"previousPageNo": 0,
	"descendingOrder": true
}