Tenant search

Tenant search

GET /api/v1/tenants

Only tenants available to the user are displayed.

Access: administrator and analyst.

Query parameters (URL Query)

Name	Data type	Mandatory	Description	Value example
page	number	No	Page number. Starts with 1. The page size is 250 entries. If the parameter is not specified, the default value is 1.	1
id	string	No	Tenant ID. If the parameter is specified several times, then a list is generated and the logical OR operator is applied.	00000000-0000-0000-0000-000000000000
name	string	No	Tenant name. Case-insensitive regular expression (PCRE).	tenant ^My tenant$
main	bool	No	Only display the main tenant. If the parameter is present in the URL query, then its value is assumed to be true. The values specified by the user are ignored. Example: /api/v1/tenants?main

Response

HTTP code: 200

Format: JSON

type Response []Tenant

type Tenant struct {

ID string `json:"id"`

Name string `json:"name"`

Main bool `json:"main"`

Description string `json:"description"`

EPS uint64 `json:"eps"`

EPSLimit uint64 `json:"epsLimit"`

Created string `json:"created"`

Updated string `json:"updated"`

}

Possible errors

HTTP code	Description	message field value	details field value
400	Invalid value of the "page" parameter	invalid query parameter value	page
500	Any other internal errors	variable	variable