Schemathesis 4.30.1

access_control 24 operations 24 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/access-control/roles

3parameters

4keywords

100%

Query Parameters4 of 4 keywords covered

delegatable1 / 1

#validinvalidschema

13760{

23760 "type": "boolean"

33760}

includeHidden1 / 1

13668{

23668 "type": "boolean"

33668}

targetOrgId2 / 2

13472{

23472 "format": "int64",

33967 "type": "integer"

43472}

Responses0 of 3 documented received

codedescriptionhitsavg

200(empty)0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1364ms

401Unauthorized91ms

POST /api/access-control/roles

1parameter

19keywords

100%

Body19 of 19 keywords covered

application/json19 / 19

CreateRoleForm

#validinvalidschema

16378{

24873 "properties": {

3916 "description": {

4916 "type": "string"

5916 },

6935 "displayName": {

7935 "type": "string"

8935 },

9945 "global": {

10945 "type": "boolean"

11945 },

12895 "group": {

13895 "type": "string"

14895 },

15967 "hidden": {

16967 "type": "boolean"

17967 },

18905 "name": {

19905 "type": "string"

20905 },

215737 "permissions": {

225732 "items": {

237134 "$ref": "#/components/schemas/Permission"

245732 },

25895 "type": "array"

265737 },

27845 "uid": {

28845 "type": "string"

29845 }

304873 },

311365 "type": "object"

326378}

Referenced Components (1)9 of 9 keywords

Permission9 of 9 keywords

17134{

25329 "properties": {

3595 "action": {

4595 "type": "string"

5595 },

65310 "created": {

7535 "format": "date-time",

8585 "type": "string"

95310 },

10545 "scope": {

11545 "type": "string"

12545 },

13459 "updated": {

14454 "format": "date-time",

15495 "type": "string"

16459 }

175329 },

181005 "type": "object"

197134}

Responses0 of 4 documented received

codedescriptionhitsavg

201(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1963ms

401Unauthorized51ms

DELETE /api/access-control/roles/{roleUID}

3parameters

3keywords

100%

Path Parameters1 of 1 keywords covered

roleUID1 / 1

#validinvalidschema

1126n/a{

2126n/a "type": "string"

3126n/a}

Query Parameters2 of 2 keywords covered

force1 / 1

12660{

22660 "type": "boolean"

32660}

global1 / 1

12760{

22760 "type": "boolean"

32760}

Responses0 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1193ms

401Unauthorized71ms

GET /api/access-control/roles/{roleUID}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

roleUID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses0 of 3 documented received

codedescriptionhitsavg

200(empty)0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found454ms

401Unauthorized571ms

PUT /api/access-control/roles/{roleUID}

2parameters

20keywords

100%

Path Parameters1 of 1 keywords covered

roleUID1 / 1

#validinvalidschema

1191n/a{

2191n/a "type": "string"

3191n/a}

Body19 of 19 keywords covered

application/json19 / 19

UpdateRoleCommand

15582{

26368 "properties": {

31246 "description": {

41246 "type": "string"

51246 },

61196 "displayName": {

71196 "type": "string"

81196 },

9885 "global": {

10885 "type": "boolean"

11885 },

121246 "group": {

131246 "type": "string"

141246 },

15965 "hidden": {

16965 "type": "boolean"

17965 },

181016 "name": {

191016 "type": "string"

201016 },

216237 "permissions": {

226232 "items": {

2310540 "$ref": "#/components/schemas/Permission"

246232 },

25945 "type": "array"

266237 }

276368 },

281238 "required": [

291256 "displayName",

301301 "description",

311301 "group"

321238 ],

331316 "type": "object"

345582}

Referenced Components (1)9 of 9 keywords

Permission9 of 9 keywords

110540{

27635 "properties": {

3695 "action": {

4695 "type": "string"

5695 },

6809 "created": {

7804 "format": "date-time",

8845 "type": "string"

9809 },

10609 "scope": {

11609 "type": "string"

12609 },

135016 "updated": {

14501 "format": "date-time",

155115 "type": "string"

165016 }

177635 },

181405 "type": "object"

1910540}

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1793ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized121ms

GET /api/access-control/roles/{roleUID}/assignments

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

roleUID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.384ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized641ms

PUT /api/access-control/roles/{roleUID}/assignments

2parameters

12keywords

100%

Path Parameters1 of 1 keywords covered

roleUID1 / 1

#validinvalidschema

1165n/a{

2165n/a "type": "string"

3165n/a}

Body11 of 11 keywords covered

application/json11 / 11

SetRoleAssignmentsCommand

15697{

23985 "properties": {

35750 "service_accounts": {

45742 "items": {

564184 "format": "int64",

666182 "type": "integer"

75742 },

8998 "type": "array"

95750 },

105515 "teams": {

115510 "items": {

126836 "format": "int64",

13986 "type": "integer"

145510 },

15655 "type": "array"

165515 },

175020 "users": {

185015 "items": {

198415 "format": "int64",

20936 "type": "integer"

215015 },

22655 "type": "array"

235020 }

243985 },

2514112 "type": "object"

265697}

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1533ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized120ms

GET /api/access-control/status

0parameters

0keywords

—

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.264ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized761ms

POST /api/access-control/teams/roles/search

1parameter

11keywords

100%

Body11 of 11 keywords covered

application/json11 / 11

RolesSearchQuery

#validinvalidschema

18084{

27674 "properties": {

37533 "includeHidden": {

47533 "type": "boolean"

57533 },

612515 "orgId": {

712515 "format": "int64",

813010 "type": "integer"

912515 },

108124 "teamIds": {

118114 "items": {

1214036 "format": "int64",

1314432 "type": "integer"

148114 },

159510 "type": "array"

168124 },

177137 "userIds": {

18719 "items": {

1914311 "format": "int64",

201486 "type": "integer"

21719 },

228028 "type": "array"

237137 }

247674 },

2515410 "type": "object"

268084}

Responses0 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1593ms

401Unauthorized91ms

GET /api/access-control/teams/{teamId}/roles

2parameters

4keywords

100%

Path Parameters2 of 2 keywords covered

teamId2 / 2

#validinvalidschema

11167{

21167 "format": "int64",

31176 "type": "integer"

41167}

Query Parameters2 of 2 keywords covered

targetOrgId2 / 2

17515{

27515 "format": "int64",

37614 "type": "integer"

47515}

Responses0 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1213ms

401Unauthorized20ms

POST /api/access-control/teams/{teamId}/roles

2parameters

5keywords

100%

Path Parameters2 of 2 keywords covered

teamId2 / 2

#validinvalidschema

11197{

21197 "format": "int64",

31206 "type": "integer"

41197}

Body3 of 3 keywords covered

application/json3 / 3

AddTeamRoleCommand

110219{

2338 "properties": {

3338 "roleUid": {

4338 "type": "string"

5338 }

6338 },

711011 "type": "object"

810219}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1263ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/access-control/teams/{teamId}/roles

3parameters

9keywords

100%

Path Parameters2 of 2 keywords covered

teamId2 / 2

#validinvalidschema

11437{

21437 "format": "int64",

31446 "type": "integer"

41437}

Query Parameters2 of 2 keywords covered

targetOrgId2 / 2

16720{

26720 "format": "int64",

36819 "type": "integer"

46720}

Body5 of 5 keywords covered

application/json5 / 5

SetTeamRolesCommand

111323{

25118 "properties": {

3526 "includeHidden": {

4526 "type": "boolean"

5526 },

64413 "roleUids": {

7448 "items": {

85317 "type": "string"

9448 },

10525 "type": "array"

114413 }

125118 },

131315 "type": "object"

1411323}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1493ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized11ms

DELETE /api/access-control/teams/{teamId}/roles/{roleUID}

2parameters

3keywords

100%

Path Parameters3 of 3 keywords covered

roleUID1 / 1

#validinvalidschema

113n/a{

213n/a "type": "string"

313n/a}

teamId2 / 2

167{

267 "format": "int64",

376 "type": "integer"

467}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.133ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/access-control/users/roles/search

1parameter

11keywords

100%

Body11 of 11 keywords covered

application/json11 / 11

RolesSearchQuery

#validinvalidschema

110557{

29252 "properties": {

3775 "includeHidden": {

4775 "type": "boolean"

5775 },

67315 "orgId": {

77315 "format": "int64",

87612 "type": "integer"

97315 },

109726 "teamIds": {

11978 "items": {

123518 "format": "int64",

133536 "type": "integer"

14978 },

1510518 "type": "array"

169726 },

175819 "userIds": {

18588 "items": {

19638 "format": "int64",

20656 "type": "integer"

21588 },

226611 "type": "array"

235819 }

249252 },

251575 "type": "object"

2610557}

Responses0 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1234ms

401Unauthorized451ms

GET /api/access-control/users/{userId}/roles

3parameters

5keywords

100%

Path Parameters2 of 2 keywords covered

userId2 / 2

#validinvalidschema

111131{

211131 "format": "int64",

311230 "type": "integer"

411131}

Query Parameters3 of 3 keywords covered

includeHidden1 / 1

13928{

23928 "type": "boolean"

33928}

targetOrgId2 / 2

13431{

23431 "format": "int64",

33629 "type": "integer"

43431}

Responses0 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1413ms

401Unauthorized11ms

POST /api/access-control/users/{userId}/roles

2parameters

6keywords

100%

Path Parameters2 of 2 keywords covered

userId2 / 2

#validinvalidschema

111617{

211617 "format": "int64",

311716 "type": "integer"

411617}

Body4 of 4 keywords covered

application/json4 / 4

AddUserRoleCommand

110024{

23319 "properties": {

3348 "global": {

4348 "type": "boolean"

5348 },

63013 "roleUid": {

73013 "type": "string"

83013 }

93319 },

101195 "type": "object"

1110024}

Responses1 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1303ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized31ms

PUT /api/access-control/users/{userId}/roles

3parameters

10keywords

100%

Path Parameters2 of 2 keywords covered

userId2 / 2

#validinvalidschema

114116{

214116 "format": "int64",

314215 "type": "integer"

414116}

Query Parameters2 of 2 keywords covered

targetOrgId2 / 2

17212{

27212 "format": "int64",

37311 "type": "integer"

47212}

Body6 of 6 keywords covered

application/json6 / 6

SetUserRolesCommand

112425{

25520 "properties": {

3615 "global": {

4615 "type": "boolean"

5615 },

6625 "includeHidden": {

7625 "type": "boolean"

8625 },

95510 "roleUids": {

10555 "items": {

11795 "type": "string"

12555 },

13605 "type": "array"

145510 }

155520 },

161445 "type": "object"

1712425}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1563ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized11ms

DELETE /api/access-control/users/{userId}/roles/{roleUID}

3parameters

4keywords

100%

Path Parameters3 of 3 keywords covered

roleUID1 / 1

#validinvalidschema

118n/a{

218n/a "type": "string"

318n/a}

userId2 / 2

1117{

2117 "format": "int64",

3126 "type": "integer"

4117}

Query Parameters1 of 1 keywords covered

global1 / 1

1135{

2135 "type": "boolean"

3135}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.183ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/access-control/{resource}/description

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

resource1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses0 of 3 documented received

codedescriptionhitsavg

200(empty)0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found293ms

401Unauthorized731ms

GET /api/access-control/{resource}/{resourceID}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

resource1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

resourceID1 / 1

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.443ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized580ms

POST /api/access-control/{resource}/{resourceID}

3parameters

14keywords

100%

Path Parameters2 of 2 keywords covered

resource1 / 1

#validinvalidschema

1162n/a{

2162n/a "type": "string"

3162n/a}

resourceID1 / 1

1162n/a{

2162n/a "type": "string"

3162n/a}

Body12 of 12 keywords covered

application/json12 / 12

setPermissionsCommand

110751{

27745 "properties": {

37745 "permissions": {

47739 "items": {

531555 "$ref": "#/components/schemas/SetResourcePermissionCommand"

67739 },

71166 "type": "array"

87745 }

97745 },

101526 "type": "object"

1110751}

Referenced Components (1)9 of 9 keywords

SetResourcePermissionCommand9 of 9 keywords

131555{

225650 "properties": {

32067 "builtInRole": {

42067 "type": "string"

52067 },

616226 "permission": {

716226 "type": "string"

816226 },

919131 "teamId": {

1019131 "format": "int64",

112166 "type": "integer"

1219131 },

132109 "userId": {

142109 "format": "int64",

152136 "type": "integer"

162109 }

1725650 },

183655 "type": "object"

1931555}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1464ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized161ms

POST /api/access-control/{resource}/{resourceID}/builtInRoles/{builtInRole}

4parameters

6keywords

100%

Path Parameters3 of 3 keywords covered

resource1 / 1

#validinvalidschema

1115n/a{

2115n/a "type": "string"

3115n/a}

resourceID1 / 1

1115n/a{

2115n/a "type": "string"

3115n/a}

builtInRole1 / 1

1115n/a{

2115n/a "type": "string"

3115n/a}

Body3 of 3 keywords covered

application/json3 / 3

setPermissionCommand

14552{

22140 "properties": {

32140 "permission": {

42140 "type": "string"

52140 }

62140 },

78512 "type": "object"

84552}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1113ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized41ms

POST /api/access-control/{resource}/{resourceID}/teams/{teamID}

4parameters

7keywords

100%

Path Parameters4 of 4 keywords covered

resource1 / 1

#validinvalidschema

1125n/a{

2125n/a "type": "string"

3125n/a}

resourceID1 / 1

1125n/a{

2125n/a "type": "string"

3125n/a}

teamID2 / 2

110619{

210619 "format": "int64",

310718 "type": "integer"

410619}

Body3 of 3 keywords covered

application/json3 / 3

setPermissionCommand

110513{

2275 "properties": {

3275 "permission": {

4275 "type": "string"

5275 }

6275 },

71108 "type": "object"

810513}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1243ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized11ms

POST /api/access-control/{resource}/{resourceID}/users/{userID}

4parameters

7keywords

100%

Path Parameters4 of 4 keywords covered

resource1 / 1

#validinvalidschema

1125n/a{

2125n/a "type": "string"

3125n/a}

resourceID1 / 1

1125n/a{

2125n/a "type": "string"

3125n/a}

userID2 / 2

110124{

210124 "format": "int64",

310223 "type": "integer"

410124}

Body3 of 3 keywords covered

application/json3 / 3

setPermissionCommand

18923{

22518 "properties": {

32518 "permission": {

42518 "type": "string"

52518 }

62518 },

71075 "type": "object"

88923}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1243ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized10ms

admin 2 operations 2 covered 0 partial 0 uncovered 0 not measured —

#

GET /api/admin/settings

0parameters

0keywords

—

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)1825ms

401UnauthorizedError is returned when the request is not authenticated.870ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

GET /api/admin/stats

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)298ms

401UnauthorizedError is returned when the request is not authenticated.761ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

admin_ldap 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/admin/ldap-sync-status

0parameters

0keywords

—

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.691ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found334ms

POST /api/admin/ldap/reload

0parameters

0keywords

—

Responses1 of 1 documented received

codedescriptionhitsavg

410GoneError is returned when the requested endpoint was removed.293ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized740ms

GET /api/admin/ldap/status

0parameters

0keywords

—

Responses1 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.800ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request233ms

POST /api/admin/ldap/sync/{user_id}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

19716{

29716 "format": "int64",

39914 "type": "integer"

49716}

Responses1 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.131ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request1003ms

GET /api/admin/ldap/{user_name}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

user_name1 / 1

#validinvalidschema

1103n/a{

2103n/a "type": "string"

3103n/a}

Responses1 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.770ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request263ms

admin_provisioning 4 operations 4 covered 0 partial 0 uncovered 0 not measured —

#

POST /api/admin/provisioning/access-control/reload

0parameters

0keywords

—

Responses1 of 3 documented received

codedescriptionhitsavg

202AcceptedResponse0never seen

401UnauthorizedError is returned when the request is not authenticated.610ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found413ms

POST /api/admin/provisioning/dashboards/reload

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.2338ms

401UnauthorizedError is returned when the request is not authenticated.821ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/admin/provisioning/datasources/reload

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.343ms

401UnauthorizedError is returned when the request is not authenticated.710ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/admin/provisioning/plugins/reload

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.283ms

401UnauthorizedError is returned when the request is not authenticated.770ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

admin_users 9 operations 9 covered 0 partial 0 uncovered 0 not measured 100%

#

POST /api/admin/users

1parameter

9keywords

100%

Body9 of 9 keywords covered

application/json9 / 9

AdminCreateUserForm

#validinvalidschema

15543{

24235 "properties": {

35112 "email": {

45112 "type": "string"

55112 },

6515 "login": {

7515 "type": "string"

8515 },

9625 "name": {

10625 "type": "string"

11625 },

124514 "orgId": {

134514 "format": "int64",

144712 "type": "integer"

154514 },

16565 "password": {

17565 "$ref": "#/components/schemas/Password"

18565 }

194235 },

20908 "type": "object"

215543}

Referenced Components (1)1 of 1 keywords

Password1 of 1 keywords

1565{

2565 "type": "string"

3565}

Responses3 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.1254ms

401UnauthorizedError is returned when the request is not authenticated.251ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

412PreconditionFailedError14ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/admin/users/{user_id}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

18233{

28233 "format": "int64",

38332 "type": "integer"

48233}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.1166ms

401UnauthorizedError is returned when the request is not authenticated.141ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1003ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/admin/users/{user_id}/auth-tokens

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

16352{

26352 "format": "int64",

36550 "type": "integer"

46352}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)293ms

401UnauthorizedError is returned when the request is not authenticated.100ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found763ms

POST /api/admin/users/{user_id}/disable

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

19023{

29023 "format": "int64",

39221 "type": "integer"

49023}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.140ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.993ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/admin/users/{user_id}/enable

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

18924{

28924 "format": "int64",

39023 "type": "integer"

48924}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.180ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.954ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/admin/users/{user_id}/logout

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

110211{

210211 "format": "int64",

310310 "type": "integer"

410211}

Responses2 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.171ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.963ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/admin/users/{user_id}/password

2parameters

6keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

111412{

211412 "format": "int64",

311511 "type": "integer"

411412}

Body4 of 4 keywords covered

application/json4 / 4

AdminUpdateUserPasswordForm

19815{

2325 "properties": {

3325 "password": {

4325 "$ref": "#/components/schemas/Password"

5325 }

6325 },

710310 "type": "object"

89815}

Referenced Components (1)1 of 1 keywords

Password1 of 1 keywords

1325{

2325 "type": "string"

3325}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.953ms

401UnauthorizedError is returned when the request is not authenticated.30ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.164ms

Undocumented - not in spec

codedescriptionhitsavg

404Not Found123ms

PUT /api/admin/users/{user_id}/permissions

2parameters

5keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

110719{

210719 "format": "int64",

310818 "type": "integer"

410719}

Body3 of 3 keywords covered

application/json3 / 3

AdminUpdateUserPermissionsForm

19319{

22813 "properties": {

32813 "isGrafanaAdmin": {

42813 "type": "boolean"

52813 }

62813 },

71066 "type": "object"

89319}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.203ms

401UnauthorizedError is returned when the request is not authenticated.11ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.864ms

Undocumented - not in spec

codedescriptionhitsavg

404Not Found193ms

POST /api/admin/users/{user_id}/revoke-auth-token

2parameters

6keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

112310{

212310 "format": "int64",

31249 "type": "integer"

412310}

Body4 of 4 keywords covered

application/json4 / 4

RevokeAuthTokenCmd

110619{

23714 "properties": {

33714 "authTokenId": {

43714 "format": "int64",

5447 "type": "integer"

63714 }

73714 },

81205 "type": "object"

910619}

Responses3 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.254ms

401UnauthorizedError is returned when the request is not authenticated.191ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.893ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

annotations 9 operations 9 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/annotations

13parameters

22keywords

100%

Query Parameters22 of 22 keywords covered

from2 / 2

#validinvalidschema

19914{

29914 "format": "int64",

310112 "type": "integer"

49914}

to2 / 2

19214{

29214 "format": "int64",

39412 "type": "integer"

49214}

userId2 / 2

18816{

28816 "format": "int64",

39014 "type": "integer"

48816}

userUID1 / 1

198n/a{

298n/a "type": "string"

398n/a}

alertId2 / 2

110416{

210416 "format": "int64",

310614 "type": "integer"

410416}

alertUID1 / 1

1109n/a{

2109n/a "type": "string"

3109n/a}

dashboardId2 / 2

19915{

29915 "format": "int64",

310113 "type": "integer"

49915}

dashboardUID1 / 1

1106n/a{

2106n/a "type": "string"

3106n/a}

panelId2 / 2

19614{

29614 "format": "int64",

39812 "type": "integer"

49614}

limit2 / 2

19714{

29714 "format": "int64",

39912 "type": "integer"

49714}

tags2 / 2

1104n/a{

2104n/a "items": {

3110n/a "type": "string"

4104n/a },

5104n/a "type": "array"

6104n/a}

type2 / 2

19016{

29016 "enum": [

388n/a "alert",

42n/a "annotation"

59016 ],

6106n/a "type": "string"

79016}

matchAny1 / 1

19612{

29612 "type": "boolean"

39612}

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)944ms

401UnauthorizedError is returned when the request is not authenticated.41ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request993ms

POST /api/annotations

1parameter

17keywords

100%

Body17 of 17 keywords covered

application/json17 / 17

PostAnnotationsCmd

#validinvalidschema

112767{

212959 "properties": {

31388 "dashboardId": {

41388 "format": "int64",

51406 "type": "integer"

61388 },

71526 "dashboardUID": {

81526 "type": "string"

91526 },

101446 "data": {

111446 "$ref": "#/components/schemas/Json"

121446 },

131348 "panelId": {

141348 "format": "int64",

151366 "type": "integer"

161348 },

1712911 "tags": {

181296 "items": {

1932715 "type": "string"

201296 },

211355 "type": "array"

2212911 },

231815 "text": {

241815 "type": "string"

251815 },

261389 "time": {

271389 "format": "int64",

281407 "type": "integer"

291389 },

30908 "timeEnd": {

31908 "format": "int64",

32926 "type": "integer"

33908 }

3412959 },

351863 "required": [

361863 "text"

371863 ],

381895 "type": "object"

3912767}

Referenced Components (1)1 of 1 keywords

Json1 of 1 keywords

11446{

21446 "type": "object"

31446}

Responses4 of 5 documented received

codedescriptionhitsavg

200(empty)1220ms

400BadRequestError is returned when the request is invalid and it cannot be processed.1033ms

401UnauthorizedError is returned when the request is not authenticated.131ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.724ms

POST /api/annotations/graphite

1parameter

6keywords

100%

Body6 of 6 keywords covered

application/json6 / 6

PostGraphiteAnnotationsCmd

#validinvalidschema

16026{

24221 "properties": {

3535 "data": {

4535 "type": "string"

5535 },

632n/a "tags": {},

7447 "what": {

8447 "type": "string"

9447 },

10449 "when": {

11449 "format": "int64",

12476 "type": "integer"

13449 }

144221 },

15815 "type": "object"

166026}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.1283ms

401UnauthorizedError is returned when the request is not authenticated.161ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/annotations/mass-delete

1parameter

9keywords

100%

Body9 of 9 keywords covered

application/json9 / 9

MassDeleteAnnotationsCmd

#validinvalidschema

111341{

211033 "properties": {

312910 "annotationId": {

412910 "format": "int64",

51336 "type": "integer"

612910 },

712711 "dashboardId": {

812711 "format": "int64",

91326 "type": "integer"

1012711 },

11655 "dashboardUID": {

12655 "type": "string"

13655 },

141238 "panelId": {

151238 "format": "int64",

161256 "type": "integer"

171238 }

1811033 },

191468 "type": "object"

2011341}

Responses3 of 3 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.784ms

401UnauthorizedError is returned when the request is not authenticated.201ms

500InternalServerError is a general error indicating something went wrong internally.74ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request513ms

404Not Found43ms

GET /api/annotations/tags

2parameters

2keywords

100%

Query Parameters2 of 2 keywords covered

tag1 / 1

#validinvalidschema

130n/a{

230n/a "type": "string"

330n/a}

limit1 / 1

127n/a{

227n/a "type": "string"

327n/a}

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)584ms

401UnauthorizedError is returned when the request is not authenticated.491ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples1 / 1 used

Query

"100"limit

DELETE /api/annotations/{annotation_id}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

annotation_id1 / 1

#validinvalidschema

15n/a{

25n/a "type": "string"

35n/a}

Responses2 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.23ms

401UnauthorizedError is returned when the request is not authenticated.31ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/annotations/{annotation_id}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

annotation_id1 / 1

#validinvalidschema

15n/a{

25n/a "type": "string"

35n/a}

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)24ms

401UnauthorizedError is returned when the request is not authenticated.31ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PATCH /api/annotations/{annotation_id}

2parameters

14keywords

100%

Path Parameters1 of 1 keywords covered

annotation_id1 / 1

#validinvalidschema

177n/a{

277n/a "type": "string"

377n/a}

Body13 of 13 keywords covered

application/json13 / 13

PatchAnnotationsCmd

12549{

22444 "properties": {

3585 "data": {

4585 "$ref": "#/components/schemas/Json"

5585 },

6558 "id": {

7558 "format": "int64",

8576 "type": "integer"

9558 },

105210 "tags": {

11525 "items": {

1215 "type": "string"

13525 },

14575 "type": "array"

155210 },

16565 "text": {

17565 "type": "string"

18565 },

19528 "time": {

20528 "format": "int64",

21546 "type": "integer"

22528 },

23518 "timeEnd": {

24518 "format": "int64",

25536 "type": "integer"

26518 }

272444 },

28695 "type": "object"

292549}

Referenced Components (1)1 of 1 keywords

Json1 of 1 keywords

1585{

2585 "type": "object"

3585}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.374ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request403ms

PUT /api/annotations/{annotation_id}

2parameters

14keywords

100%

Path Parameters1 of 1 keywords covered

annotation_id1 / 1

#validinvalidschema

1177n/a{

2177n/a "type": "string"

3177n/a}

Body13 of 13 keywords covered

application/json13 / 13

UpdateAnnotationsCmd

16557{

25451 "properties": {

3915 "data": {

4915 "$ref": "#/components/schemas/Json"

5915 },

67714 "id": {

77714 "format": "int64",

8847 "type": "integer"

97714 },

107310 "tags": {

11735 "items": {

12945 "type": "string"

13735 },

14785 "type": "array"

157310 },

16745 "text": {

17745 "type": "string"

18745 },

19758 "time": {

20758 "format": "int64",

21776 "type": "integer"

22758 },

23739 "timeEnd": {

24739 "format": "int64",

25766 "type": "integer"

26739 }

275451 },

281166 "type": "object"

296557}

Referenced Components (1)1 of 1 keywords

Json1 of 1 keywords

1915{

2915 "type": "object"

3915}

Responses4 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.403ms

401UnauthorizedError is returned when the request is not authenticated.81ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.923ms

500InternalServerError is a general error indicating something went wrong internally.374ms

convert_prometheus 14 operations 12 covered 2 partial 0 uncovered 0 not measured 35%

#

GET /api/convert/api/prom/rules

0parameters

0keywords

—

Responses1 of 3 documented received

codedescriptionhitsavg

200PrometheusNamespace225ms

403ForbiddenError0never seen

404NotFound0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized831ms

POST /api/convert/api/prom/rules

0parameters

0keywords

—

Responses0 of 2 documented received

codedescriptionhitsavg

202ConvertPrometheusResponse0never seen

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request293ms

41513ms

401Unauthorized720ms

DELETE /api/convert/api/prom/rules/{NamespaceTitle}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

NamespaceTitle1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses0 of 2 documented received

codedescriptionhitsavg

202ConvertPrometheusResponse0never seen

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found454ms

401Unauthorized570ms

GET /api/convert/api/prom/rules/{NamespaceTitle}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

NamespaceTitle1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

200PrometheusNamespace0never seen

403ForbiddenError0never seen

404NotFound384ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized641ms

POST /api/convert/api/prom/rules/{NamespaceTitle}

8parameters

31keywords

22%

Path Parameters1 of 1 keywords covered

NamespaceTitle1 / 1

#validinvalidschema

1273n/a{

2273n/a "type": "string"

3273n/a}

Headers6 of 6 keywords covered

x-grafana-alerting-datasource-uid1 / 1

1179n/a{

2179n/a "type": "string"

3179n/a}

x-grafana-alerting-recording-rules-paused1 / 1

115731{

215731 "type": "boolean"

315731}

x-grafana-alerting-alert-rules-paused1 / 1

116125{

216125 "type": "boolean"

316125}

x-grafana-alerting-target-datasource-uid1 / 1

1173n/a{

2173n/a "type": "string"

3173n/a}

x-grafana-alerting-folder-uid1 / 1

1183n/a{

2183n/a "type": "string"

3183n/a}

x-grafana-alerting-notification-settings1 / 1

1171n/a{

2171n/a "type": "string"

3171n/a}

Body0 of 24 keywords covered

application/yaml0 / 24

PrometheusRuleGroup

100{

200 "properties": {

300 "interval": {

400 "$ref": "#/components/schemas/Duration"

500 },

600 "labels": {

700 "additionalProperties": {

800 "type": "string"

900 },

1000 "type": "object"

1100 },

1200 "limit": {

1300 "format": "int64",

1400 "type": "integer"

1500 },

1600 "name": {

1700 "type": "string"

1800 },

1900 "query_offset": {

2000 "type": "string"

2100 },

2200 "rules": {

2300 "items": {

2400 "$ref": "#/components/schemas/PrometheusRule"

2500 },

2600 "type": "array"

2700 }

2800 },

2900 "type": "object"

3000}

Referenced Components (2)0 of 14 keywords

Duration0 of 2 keywords

100{

200 "format": "int64",

300 "type": "integer"

400}

PrometheusRule0 of 12 keywords

100{

200 "properties": {

300 "alert": {

400 "type": "string"

500 },

600 "annotations": {

700 "additionalProperties": {

800 "type": "string"

900 },

1000 "type": "object"

1100 },

1200 "expr": {

1300 "type": "string"

1400 },

1500 "for": {

1600 "type": "string"

1700 },

1800 "keep_firing_for": {

1900 "type": "string"

2000 },

2100 "labels": {

2200 "additionalProperties": {

2300 "type": "string"

2400 },

2500 "type": "object"

2600 },

2700 "record": {

2800 "type": "string"

2900 }

3000 },

3100 "type": "object"

3200}

Responses0 of 2 documented received

codedescriptionhitsavg

202ConvertPrometheusResponse0never seen

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

500Internal Server Error2093ms

400Bad Request573ms

41523ms

404Not Found43ms

401Unauthorized11ms

DELETE /api/convert/api/prom/rules/{NamespaceTitle}/{Group}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

NamespaceTitle1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Group1 / 1

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses0 of 2 documented received

codedescriptionhitsavg

202ConvertPrometheusResponse0never seen

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found374ms

401Unauthorized650ms

GET /api/convert/api/prom/rules/{NamespaceTitle}/{Group}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

NamespaceTitle1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Group1 / 1

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

200PrometheusRuleGroup0never seen

403ForbiddenError0never seen

404NotFound434ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized591ms

GET /api/convert/prometheus/config/v1/rules

0parameters

0keywords

—

Responses1 of 3 documented received

codedescriptionhitsavg

200PrometheusNamespace355ms

403ForbiddenError0never seen

404NotFound0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized701ms

POST /api/convert/prometheus/config/v1/rules

0parameters

0keywords

—

Responses0 of 2 documented received

codedescriptionhitsavg

202ConvertPrometheusResponse0never seen

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request263ms

41513ms

401Unauthorized750ms

DELETE /api/convert/prometheus/config/v1/rules/{NamespaceTitle}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

NamespaceTitle1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses0 of 2 documented received

codedescriptionhitsavg

202ConvertPrometheusResponse0never seen

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found374ms

401Unauthorized650ms

GET /api/convert/prometheus/config/v1/rules/{NamespaceTitle}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

NamespaceTitle1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

200PrometheusNamespace0never seen

403ForbiddenError0never seen

404NotFound334ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized691ms

POST /api/convert/prometheus/config/v1/rules/{NamespaceTitle}

8parameters

31keywords

22%

Path Parameters1 of 1 keywords covered

NamespaceTitle1 / 1

#validinvalidschema

1273n/a{

2273n/a "type": "string"

3273n/a}

Headers6 of 6 keywords covered

x-grafana-alerting-datasource-uid1 / 1

1186n/a{

2186n/a "type": "string"

3186n/a}

x-grafana-alerting-recording-rules-paused1 / 1

115416{

215416 "type": "boolean"

315416}

x-grafana-alerting-alert-rules-paused1 / 1

116038{

216038 "type": "boolean"

316038}

x-grafana-alerting-target-datasource-uid1 / 1

1171n/a{

2171n/a "type": "string"

3171n/a}

x-grafana-alerting-folder-uid1 / 1

1182n/a{

2182n/a "type": "string"

3182n/a}

x-grafana-alerting-notification-settings1 / 1

1191n/a{

2191n/a "type": "string"

3191n/a}

Body0 of 24 keywords covered

application/yaml0 / 24

PrometheusRuleGroup

100{

200 "properties": {

300 "interval": {

400 "$ref": "#/components/schemas/Duration"

500 },

600 "labels": {

700 "additionalProperties": {

800 "type": "string"

900 },

1000 "type": "object"

1100 },

1200 "limit": {

1300 "format": "int64",

1400 "type": "integer"

1500 },

1600 "name": {

1700 "type": "string"

1800 },

1900 "query_offset": {

2000 "type": "string"

2100 },

2200 "rules": {

2300 "items": {

2400 "$ref": "#/components/schemas/PrometheusRule"

2500 },

2600 "type": "array"

2700 }

2800 },

2900 "type": "object"

3000}

Referenced Components (2)0 of 14 keywords

Duration0 of 2 keywords

100{

200 "format": "int64",

300 "type": "integer"

400}

PrometheusRule0 of 12 keywords

100{

200 "properties": {

300 "alert": {

400 "type": "string"

500 },

600 "annotations": {

700 "additionalProperties": {

800 "type": "string"

900 },

1000 "type": "object"

1100 },

1200 "expr": {

1300 "type": "string"

1400 },

1500 "for": {

1600 "type": "string"

1700 },

1800 "keep_firing_for": {

1900 "type": "string"

2000 },

2100 "labels": {

2200 "additionalProperties": {

2300 "type": "string"

2400 },

2500 "type": "object"

2600 },

2700 "record": {

2800 "type": "string"

2900 }

3000 },

3100 "type": "object"

3200}

Responses0 of 2 documented received

codedescriptionhitsavg

202ConvertPrometheusResponse0never seen

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

500Internal Server Error1934ms

400Bad Request534ms

41524ms

401Unauthorized241ms

404Not Found14ms

DELETE /api/convert/prometheus/config/v1/rules/{NamespaceTitle}/{Group}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

NamespaceTitle1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Group1 / 1

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses0 of 2 documented received

codedescriptionhitsavg

202ConvertPrometheusResponse0never seen

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found284ms

401Unauthorized741ms

GET /api/convert/prometheus/config/v1/rules/{NamespaceTitle}/{Group}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

NamespaceTitle1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Group1 / 1

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

200PrometheusRuleGroup0never seen

403ForbiddenError0never seen

404NotFound365ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized661ms

dashboards 25 operations 25 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/dashboard/snapshots

2parameters

3keywords

100%

Query Parameters3 of 3 keywords covered

query1 / 1

#validinvalidschema

171n/a{

271n/a "type": "string"

371n/a}

limit2 / 2

12968{

22968 "format": "int64",

33265 "type": "integer"

42968}

Responses1 of 2 documented received

codedescriptionhitsavg

200(empty)1124ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized131ms

Examples1 / 1 used

Query

1000limit

POST /api/dashboards/db

1parameter

14keywords

100%

Body14 of 14 keywords covered

application/json14 / 14

SaveDashboardCommand

#validinvalidschema

16162{

25457 "properties": {

38212 "UpdatedAt": {

4827 "format": "date-time",

5895 "type": "string"

68212 },

7865 "dashboard": {

8865 "$ref": "#/components/schemas/Json"

9865 },

10749 "folderId": {

11749 "format": "int64",

12767 "type": "integer"

13749 },

14828 "folderUid": {

15828 "type": "string"

16828 },

17806 "isFolder": {

18806 "type": "boolean"

19806 },

20685 "message": {

21685 "type": "string"

22685 },

23837 "overwrite": {

24837 "type": "boolean"

25837 },

26749 "userId": {

27749 "format": "int64",

28776 "type": "integer"

29749 }

305457 },

311185 "type": "object"

326162}

Referenced Components (1)1 of 1 keywords

Json1 of 1 keywords

1865{

2865 "type": "object"

3865}

Responses2 of 8 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.1783ms

401UnauthorizedError is returned when the request is not authenticated.30ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

412PreconditionFailedError0never seen

422UnprocessableEntityError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/dashboards/home

0parameters

0keywords

—

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)335ms

401UnauthorizedError is returned when the request is not authenticated.721ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/dashboards/import

1parameter

18keywords

100%

Body18 of 18 keywords covered

application/json18 / 18

ImportDashboardRequest

#validinvalidschema

16278{

25072 "properties": {

31005 "dashboard": {

41005 "$ref": "#/components/schemas/Json"

51005 },

69415 "folderId": {

79415 "format": "int64",

81036 "type": "integer"

99415 },

10945 "folderUid": {

11945 "type": "string"

12945 },

136732 "inputs": {

146727 "items": {

153832 "$ref": "#/components/schemas/ImportDashboardInput"

166727 },

17945 "type": "array"

186732 },

19915 "overwrite": {

20915 "type": "boolean"

21915 },

22887 "path": {

23887 "type": "string"

24887 },

25905 "pluginId": {

26905 "type": "string"

27905 }

285072 },

291346 "type": "object"

306278}

Referenced Components (2)8 of 8 keywords

ImportDashboardInput7 of 7 keywords

13832{

22627 "properties": {

3355 "name": {

4355 "type": "string"

5355 },

6345 "pluginId": {

7345 "type": "string"

8345 },

9295 "type": {

10295 "type": "string"

11295 },

123112 "value": {

133112 "type": "string"

143112 }

152627 },

16655 "type": "object"

173832}

Json1 of 1 keywords

11005{

21005 "type": "object"

31005}

Responses4 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.1613ms

401UnauthorizedError is returned when the request is not authenticated.11ms

412PreconditionFailedError0never seen

422UnprocessableEntityError294ms

500InternalServerError is a general error indicating something went wrong internally.74ms

POST /api/dashboards/interpolate

0parameters

0keywords

—

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.680ms

422UnprocessableEntityError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found343ms

GET /api/dashboards/public-dashboards

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)344ms

401UnauthorisedPublicError is returned when the request is not authenticated.711ms

403ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerPublicError is a general error indicating something went wrong internally.0never seen

GET /api/dashboards/tags

0parameters

0keywords

—

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)204ms

401UnauthorizedError is returned when the request is not authenticated.851ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/dashboards/uid/{dashboardUid}/public-dashboards

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

dashboardUid1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses3 of 6 documented received

codedescriptionhitsavg

200(empty)254ms

400BadRequestPublicError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorisedPublicError is returned when the request is not authenticated.771ms

403ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundPublicError is returned when the requested resource was not found.34ms

500InternalServerPublicError is a general error indicating something went wrong internally.0never seen

POST /api/dashboards/uid/{dashboardUid}/public-dashboards

2parameters

10keywords

100%

Path Parameters1 of 1 keywords covered

dashboardUid1 / 1

#validinvalidschema

1156n/a{

2156n/a "type": "string"

3156n/a}

Body9 of 9 keywords covered

application/json9 / 9

PublicDashboardDTO

111140{

27332 "properties": {

3845 "accessToken": {

4845 "type": "string"

5845 },

6736 "annotationsEnabled": {

7736 "type": "boolean"

8736 },

9786 "isEnabled": {

10786 "type": "boolean"

11786 },

12756 "share": {

13756 "$ref": "#/components/schemas/ShareType"

14756 },

15696 "timeSelectionEnabled": {

16696 "type": "boolean"

17696 },

18745 "uid": {

19745 "type": "string"

20745 }

217332 },

221438 "type": "object"

2311140}

Referenced Components (1)1 of 1 keywords

ShareType1 of 1 keywords

1756{

2756 "type": "string"

3756}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)228ms

400BadRequestPublicError is returned when the request is invalid and it cannot be processed.1244ms

401UnauthorisedPublicError is returned when the request is not authenticated.81ms

403ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerPublicError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found224ms

DELETE /api/dashboards/uid/{dashboardUid}/public-dashboards/{uid}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

dashboardUid1 / 1

#validinvalidschema

13n/a{

23n/a "type": "string"

33n/a}

uid1 / 1

13n/a{

23n/a "type": "string"

33n/a}

Responses0 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestPublicError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorisedPublicError is returned when the request is not authenticated.0never seen

403ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerPublicError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found33ms

PATCH /api/dashboards/uid/{dashboardUid}/public-dashboards/{uid}

3parameters

11keywords

100%

Path Parameters2 of 2 keywords covered

dashboardUid1 / 1

#validinvalidschema

1153n/a{

2153n/a "type": "string"

3153n/a}

uid1 / 1

1153n/a{

2153n/a "type": "string"

3153n/a}

Body9 of 9 keywords covered

application/json9 / 9

PublicDashboardDTO

15539{

23934 "properties": {

3506 "accessToken": {

4506 "type": "string"

5506 },

6486 "annotationsEnabled": {

7486 "type": "boolean"

8486 },

9506 "isEnabled": {

10506 "type": "boolean"

11506 },

12536 "share": {

13536 "$ref": "#/components/schemas/ShareType"

14536 },

15487 "timeSelectionEnabled": {

16487 "type": "boolean"

17487 },

18437 "uid": {

19437 "type": "string"

20437 }

213934 },

22895 "type": "object"

235539}

Referenced Components (1)1 of 1 keywords

ShareType1 of 1 keywords

1536{

2536 "type": "string"

3536}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestPublicError is returned when the request is invalid and it cannot be processed.983ms

401UnauthorisedPublicError is returned when the request is not authenticated.30ms

403ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerPublicError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found524ms

DELETE /api/dashboards/uid/{uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.24ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/dashboards/uid/{uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.24ms

406NotAcceptableError is returned when the server cannot produce a response matching the accepted formats.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/dashboards/uid/{uid}/permissions

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.23ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/dashboards/uid/{uid}/permissions

2parameters

16keywords

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1173n/a{

2173n/a "type": "string"

3173n/a}

Body15 of 15 keywords covered

application/json15 / 15

UpdateDashboardACLCommand

18777{

24471 "properties": {

34471 "items": {

44466 "items": {

5423158 "$ref": "#/components/schemas/DashboardACLUpdateItem"

64466 },

71105 "type": "array"

84471 }

94471 },

101586 "type": "object"

118777}

Referenced Components (2)13 of 13 keywords

DashboardACLUpdateItem11 of 11 keywords

1423158{

229956 "properties": {

321418 "permission": {

421418 "$ref": "#/components/schemas/PermissionType"

521418 },

622711 "role": {

722711 "enum": [

885n/a "None",

950n/a "Viewer",

1039n/a "Editor",

1153n/a "Admin"

1222711 ],

132335 "type": "string"

1422711 },

1523013 "teamId": {

1623013 "format": "int64",

172349 "type": "integer"

1823013 },

1922420 "userId": {

2022420 "format": "int64",

212386 "type": "integer"

2222420 }

2329956 },

24479102 "type": "object"

25423158}

PermissionType2 of 2 keywords

121418{

221418 "format": "int64",

32266 "type": "integer"

421418}

Responses3 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.903ms

401UnauthorizedError is returned when the request is not authenticated.71ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.764ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/dashboards/uid/{uid}/restore

2parameters

5keywords

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1122n/a{

2122n/a "type": "string"

3122n/a}

Body4 of 4 keywords covered

application/json4 / 4

RestoreDashboardVersionCommand

19414{

2158 "properties": {

3158 "version": {

4158 "format": "int64",

5176 "type": "integer"

6158 }

7158 },

81026 "type": "object"

99414}

Responses3 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.753ms

401UnauthorizedError is returned when the request is not authenticated.371ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.104ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/dashboards/uid/{uid}/versions

3parameters

5keywords

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

140n/a{

240n/a "type": "string"

340n/a}

Query Parameters4 of 4 keywords covered

limit2 / 2

11814{

21814 "format": "int64",

32012 "type": "integer"

41814}

start2 / 2

11814{

21814 "format": "int64",

32012 "type": "integer"

41814}

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.404ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples2 / 2 used

Query

0limit

0start

GET /api/dashboards/uid/{uid}/versions/{DashboardVersionID}

2parameters

3keywords

100%

Path Parameters3 of 3 keywords covered

DashboardVersionID2 / 2

#validinvalidschema

157{

257 "format": "int64",

366 "type": "integer"

457}

uid1 / 1

112n/a{

212n/a "type": "string"

312n/a}

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.124ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/public/dashboards/{accessToken}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

accessToken1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestPublicError is returned when the request is invalid and it cannot be processed.243ms

401UnauthorisedPublicError is returned when the request is not authenticated.0never seen

403ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource.782ms

404NotFoundPublicError is returned when the requested resource was not found.0never seen

500InternalServerPublicError is a general error indicating something went wrong internally.0never seen

GET /api/public/dashboards/{accessToken}/annotations

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

accessToken1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestPublicError is returned when the request is invalid and it cannot be processed.212ms

401UnauthorisedPublicError is returned when the request is not authenticated.0never seen

403ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource.812ms

404NotFoundPublicError is returned when the requested resource was not found.0never seen

500InternalServerPublicError is a general error indicating something went wrong internally.0never seen

POST /api/public/dashboards/{accessToken}/panels/{panelId}/query

2parameters

3keywords

100%

Path Parameters3 of 3 keywords covered

accessToken1 / 1

#validinvalidschema

1112n/a{

2112n/a "type": "string"

3112n/a}

panelId2 / 2

110111{

210111 "format": "int64",

31039 "type": "integer"

410111}

Responses1 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestPublicError is returned when the request is invalid and it cannot be processed.1123ms

401UnauthorisedPublicError is returned when the request is not authenticated.0never seen

403ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundPublicError is returned when the requested resource was not found.0never seen

500InternalServerPublicError is a general error indicating something went wrong internally.0never seen

POST /api/snapshots

1parameter

16keywords

100%

Body16 of 16 keywords covered

application/json16 / 16

CreateDashboardSnapshotCommand

#validinvalidschema

16858{

27348 "properties": {

3955 "apiVersion": {

4955 "type": "string"

5955 },

610610 "dashboard": {

710610 "$ref": "#/components/schemas/Unstructured"

810610 },

9875 "deleteKey": {

10875 "type": "string"

11875 },

12678 "expires": {

13678 "format": "int64",

14696 "type": "integer"

15678 },

16855 "external": {

17855 "type": "boolean"

18855 },

19765 "key": {

20765 "type": "string"

21765 },

22715 "kind": {

23715 "type": "string"

24715 },

25705 "name": {

26705 "type": "string"

27705 }

287348 },

291165 "required": [

301165 "dashboard"

311165 ],

321215 "type": "object"

336858}

Referenced Components (1)5 of 5 keywords

Unstructured5 of 5 keywords

110610{

2855 "properties": {

3855 "Object": {

428n/a "additionalProperties": {},

5855 "type": "object"

6855 }

7855 },

81115 "type": "object"

910610}

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.30ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request1813ms

Examples2 / 2 used

Body: application/json

0CreateDashboardSnapshotCommand.expires

falseCreateDashboardSnapshotCommand.external

GET /api/snapshots-delete/{deleteKey}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

deleteKey1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.551ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.473ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/snapshots/{key}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

key1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses2 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.120ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.303ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized740ms

GET /api/snapshots/{key}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

key1 / 1

#validinvalidschema

1120n/a{

2120n/a "type": "string"

3120n/a}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)1112ms

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

404NotFoundError is returned when the requested resource was not found.93ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

datasources 20 operations 20 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/datasources

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)374ms

401UnauthorizedError is returned when the request is not authenticated.680ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/datasources

1parameter

18keywords

100%

Body18 of 18 keywords covered

application/json18 / 18

AddDataSourceCommand

#validinvalidschema

112379{

211174 "properties": {

31606 "access": {

41606 "$ref": "#/components/schemas/DsAccess"

51606 },

61576 "basicAuth": {

71576 "type": "boolean"

81576 },

91035 "basicAuthUser": {

101035 "type": "string"

111035 },

121515 "database": {

131515 "type": "string"

141515 },

151526 "isDefault": {

161526 "type": "boolean"

171526 },

181516 "jsonData": {

191516 "$ref": "#/components/schemas/Json"

201516 },

211515 "name": {

221515 "type": "string"

231515 },

249211 "secureJsonData": {

25216 "additionalProperties": {

26519 "type": "string"

27216 },

28985 "type": "object"

299211 },

301476 "type": {

311476 "type": "string"

321476 },

331436 "uid": {

341436 "type": "string"

351436 },

361015 "url": {

371015 "type": "string"

381015 },

391415 "user": {

401415 "type": "string"

411415 },

421435 "withCredentials": {

431435 "type": "boolean"

441435 }

4511174 },

461975 "type": "object"

4712379}

Referenced Components (2)2 of 2 keywords

DsAccess1 of 1 keywords

11606{

21606 "type": "string"

31606}

Json1 of 1 keywords

11516{

21516 "type": "object"

31516}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)430ms

401UnauthorizedError is returned when the request is not authenticated.200ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

409ConflictError464ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request1413ms

GET /api/datasources/correlations

3parameters

7keywords

100%

Query Parameters7 of 7 keywords covered

limit3 / 3

#validinvalidschema

14364{

24661 "format": "int64",

3433 "maximum": 1000,

44661 "type": "integer"

54364}

page2 / 2

14164{

24164 "format": "int64",

34461 "type": "integer"

44164}

sourceUID2 / 2

178n/a{

278n/a "items": {

3155n/a "type": "string"

478n/a },

578n/a "type": "array"

678n/a}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)1394ms

401UnauthorizedError is returned when the request is not authenticated.160ms

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples2 / 2 used

Query

100limit

1page

GET /api/datasources/id/{name}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)73ms

401UnauthorizedError is returned when the request is not authenticated.680ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.304ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/datasources/name/{name}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)222ms

401UnauthorizedError is returned when the request is not authenticated.720ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.313ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/datasources/name/{name}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.680ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found343ms

DELETE /api/datasources/proxy/uid/{uid}/{datasource_proxy_route}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

uid1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

datasource_proxy_route1 / 1

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 6 documented received

codedescriptionhitsavg

202(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.23ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/datasources/proxy/uid/{uid}/{datasource_proxy_route}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

datasource_proxy_route1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

uid1 / 1

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.23ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/datasources/proxy/uid/{uid}/{datasource_proxy_route}

3parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

datasource_proxy_route1 / 1

#validinvalidschema

1110n/a{

2110n/a "type": "string"

3110n/a}

uid1 / 1

1110n/a{

2110n/a "type": "string"

3110n/a}

Body0 of 0 keywords covered

application/jsonno keywords

1107n/a{}

Responses3 of 7 documented received

codedescriptionhitsavg

201(empty)0never seen

202(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.123ms

401UnauthorizedError is returned when the request is not authenticated.480ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.503ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/datasources/uid/{sourceUID}/correlations

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

sourceUID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.770ms

404NotFoundError is returned when the requested resource was not found.254ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/datasources/uid/{sourceUID}/correlations

2parameters

27keywords

100%

Path Parameters1 of 1 keywords covered

sourceUID1 / 1

#validinvalidschema

1219n/a{

2219n/a "type": "string"

3219n/a}

Body26 of 26 keywords covered

application/json26 / 26

CreateCorrelationCommand

17590{

26685 "properties": {

38060 "config": {

48060 "$ref": "#/components/schemas/CorrelationConfig"

58060 },

61205 "description": {

71205 "type": "string"

81205 },

91275 "label": {

101275 "type": "string"

111275 },

121195 "provisioned": {

131195 "type": "boolean"

141195 },

151285 "targetUID": {

161285 "type": "string"

171285 },

181165 "type": {

191165 "$ref": "#/components/schemas/CorrelationType"

201165 }

216685 },

221605 "type": "object"

237590}

Referenced Components (4)22 of 22 keywords

CorrelationConfig10 of 10 keywords

18060{

28253 "properties": {

31295 "field": {

41295 "type": "string"

51295 },

61295 "target": {

7124n/a "additionalProperties": {},

81295 "type": "object"

91295 },

107838 "transformations": {

117838 "$ref": "#/components/schemas/Transformations"

127838 },

131135 "type": {

141135 "$ref": "#/components/schemas/CorrelationType"

151135 }

168253 },

171332 "required": [

181341 "field",

191341 "target"

201332 ],

211355 "type": "object"

228060}

CorrelationType1 of 1 keywords

122910{

222910 "type": "string"

322910}

Transformation9 of 9 keywords

13040{

22235 "properties": {

3315 "expression": {

4315 "type": "string"

5315 },

6305 "field": {

7305 "type": "string"

8305 },

9285 "mapValue": {

10285 "type": "string"

11285 },

122820 "type": {

132820 "enum": [

1420n/a "regex",

158n/a "logfmt"

162820 ],

17435 "type": "string"

182820 }

192235 },

20655 "type": "object"

213040}

Transformations2 of 2 keywords

17838{

27833 "items": {

33040 "$ref": "#/components/schemas/Transformation"

47833 },

51115 "type": "array"

67838}

Responses2 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.2043ms

401UnauthorizedError is returned when the request is not authenticated.150ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples5 / 5 used

Body: application/json

"message"CorrelationConfig.field

{ "prop1": "value1", "prop2": "value" }CorrelationConfig.target

"Logs to Traces"CreateCorrelationCommand.description

"My label"CreateCorrelationCommand.label

"PE1C5CBDA0504A6A3"CreateCorrelationCommand.targetUID

GET /api/datasources/uid/{sourceUID}/correlations/{correlationUID}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

sourceUID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

correlationUID1 / 1

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.630ms

404NotFoundError is returned when the requested resource was not found.394ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PATCH /api/datasources/uid/{sourceUID}/correlations/{correlationUID}

3parameters

23keywords

100%

Path Parameters2 of 2 keywords covered

sourceUID1 / 1

#validinvalidschema

1198n/a{

2198n/a "type": "string"

3198n/a}

correlationUID1 / 1

1198n/a{

2198n/a "type": "string"

3198n/a}

Body21 of 21 keywords covered

application/json21 / 21

UpdateCorrelationCommand

16797{

25188 "properties": {

35872 "config": {

45872 "$ref": "#/components/schemas/CorrelationConfigUpdateDTO"

55872 },

6957 "description": {

7957 "type": "string"

8957 },

9978 "label": {

10978 "type": "string"

11978 },

12985 "type": {

13985 "$ref": "#/components/schemas/CorrelationType"

14985 }

155188 },

161559 "type": "object"

176797}

Referenced Components (3)18 of 18 keywords

CorrelationConfigUpdateDTO8 of 8 keywords

15872{

25165 "properties": {

31068 "field": {

41068 "type": "string"

51068 },

61025 "target": {

799n/a "additionalProperties": {},

81025 "type": "object"

91025 },

105655 "transformations": {

115650 "items": {

1230452 "$ref": "#/components/schemas/Transformation"

135650 },

141065 "type": "array"

155655 }

165165 },

171237 "type": "object"

185872}

CorrelationType1 of 1 keywords

1985{

2985 "type": "string"

3985}

Transformation9 of 9 keywords

130452{

226442 "properties": {

31945 "expression": {

41945 "type": "string"

51945 },

61585 "field": {

71585 "type": "string"

81585 },

91515 "mapValue": {

101515 "type": "string"

111515 },

1222327 "type": {

1322327 "enum": [

14119n/a "regex",

15104n/a "logfmt"

1622327 ],

172455 "type": "string"

1822327 }

1926442 },

2034610 "type": "object"

2130452}

Responses3 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.1153ms

401UnauthorizedError is returned when the request is not authenticated.50ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.783ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples5 / 5 used

Body: application/json

"message"CorrelationConfigUpdateDTO.field

{ "prop1": "value1", "prop2": "value" }CorrelationConfigUpdateDTO.target

[ { "type": "logfmt" }, { "expression": "(Superman|Batman)", "type": "regex", "variable": "name" } ]CorrelationConfigUpdateDTO.transformations

"Logs to Traces"UpdateCorrelationCommand.description

"My label"UpdateCorrelationCommand.label

DELETE /api/datasources/uid/{uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.23ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/datasources/uid/{uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.23ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/datasources/uid/{uid}

2parameters

21keywords

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1222n/a{

2222n/a "type": "string"

3222n/a}

Body20 of 20 keywords covered

application/json20 / 20

UpdateDataSourceCommand

17096{

25591 "properties": {

31135 "access": {

41135 "$ref": "#/components/schemas/DsAccess"

51135 },

61135 "basicAuth": {

71135 "type": "boolean"

81135 },

91026 "basicAuthUser": {

101026 "type": "string"

111026 },

12995 "database": {

13995 "type": "string"

14995 },

151075 "isDefault": {

161075 "type": "boolean"

171075 },

18955 "jsonData": {

19955 "$ref": "#/components/schemas/Json"

20955 },

211015 "name": {

221015 "type": "string"

231015 },

249110 "secureJsonData": {

2585 "additionalProperties": {

26235 "type": "string"

2785 },

28965 "type": "object"

299110 },

30976 "type": {

31976 "type": "string"

32976 },

331076 "uid": {

341076 "type": "string"

351076 },

36917 "url": {

37917 "type": "string"

38917 },

39885 "user": {

40885 "type": "string"

41885 },

428518 "version": {

438518 "format": "int64",

44976 "type": "integer"

458518 },

46856 "withCredentials": {

47856 "type": "boolean"

48856 }

495591 },

501615 "type": "object"

517096}

Referenced Components (2)2 of 2 keywords

DsAccess1 of 1 keywords

11135{

21135 "type": "string"

31135}

Json1 of 1 keywords

1955{

2955 "type": "object"

3955}

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.10ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

409ConflictError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request2213ms

DELETE /api/datasources/uid/{uid}/correlations/{correlationUID}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

uid1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

correlationUID1 / 1

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.23ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/datasources/uid/{uid}/health

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

13n/a{

23n/a "type": "string"

33n/a}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.33ms

GET /api/datasources/uid/{uid}/resources/{datasource_proxy_route}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

datasource_proxy_route1 / 1

#validinvalidschema

13n/a{

23n/a "type": "string"

33n/a}

uid1 / 1

13n/a{

23n/a "type": "string"

33n/a}

Responses1 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.33ms

POST /api/ds/query

1parameter

9keywords

100%

Body9 of 9 keywords covered

application/json9 / 9

MetricRequest

#validinvalidschema

14935{

25326 "properties": {

3476 "debug": {

4476 "type": "boolean"

5476 },

6716 "from": {

7716 "type": "string"

8716 },

96810 "queries": {

10685 "items": {

112265 "$ref": "#/components/schemas/Json"

12685 },

13735 "type": "array"

146810 },

15726 "to": {

16726 "type": "string"

17726 }

185326 },

19754 "required": [

20772 "from",

21781 "to",

22781 "queries"

23754 ],

24795 "type": "object"

254935}

Referenced Components (1)1 of 1 keywords

Json1 of 1 keywords

12265{

22265 "type": "object"

32265}

Responses3 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

207(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.1263ms

401UnauthorizedError is returned when the request is not authenticated.51ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.113ms

Undocumented - not in spec

codedescriptionhitsavg

404Not Found93ms

Examples3 / 3 used

Body: application/json

"now-1h"MetricRequest.from

[ { "datasource": { "uid": "PD8C576611E62080A" }, "format": "table", "intervalMs": 86400000, "maxDataPoints": 1092, "rawSql": "SELECT 1 as valueOne, 2 as valueTwo", "refId": "A" } ]MetricRequest.queries

"now"MetricRequest.to

devices 2 operations 2 covered 0 partial 0 uncovered 0 not measured —

#

GET /api/anonymous/devices

0parameters

0keywords

—

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)294ms

401UnauthorizedError is returned when the request is not authenticated.761ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/anonymous/search

0parameters

0keywords

—

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)274ms

401UnauthorizedError is returned when the request is not authenticated.781ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

enterprise 7 operations 7 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/datasources/uid/{uid}/lbac/teams

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.23ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/datasources/uid/{uid}/lbac/teams

2parameters

11keywords

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1146n/a{

2146n/a "type": "string"

3146n/a}

Body10 of 10 keywords covered

application/json10 / 10

UpdateTeamLBACCommand

18250{

26445 "properties": {

36445 "rules": {

46440 "items": {

526078 "$ref": "#/components/schemas/TeamLBACRule"

66440 },

71045 "type": "array"

86445 }

96445 },

101275 "type": "object"

118250}

Referenced Components (1)7 of 7 keywords

TeamLBACRule7 of 7 keywords

126078{

218648 "properties": {

316733 "rules": {

41675 "items": {

59675 "type": "string"

61675 },

717228 "type": "array"

816733 },

919110 "teamId": {

1019110 "type": "string"

1119110 },

1211528 "teamUid": {

1311528 "type": "string"

1411528 }

1518648 },

1630830 "type": "object"

1726078}

Responses2 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.460ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1003ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/datasources/{dataSourceUID}/cache

2parameters

2keywords

100%

Path Parameters1 of 1 keywords covered

dataSourceUID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Query Parameters1 of 1 keywords covered

dataSourceType1 / 1

139n/a{

239n/a "type": "string"

339n/a}

Responses0 of 2 documented received

codedescriptionhitsavg

200CacheConfigResponse0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found433ms

401Unauthorized590ms

POST /api/datasources/{dataSourceUID}/cache

3parameters

13keywords

100%

Path Parameters1 of 1 keywords covered

dataSourceUID1 / 1

#validinvalidschema

1173n/a{

2173n/a "type": "string"

3173n/a}

Query Parameters1 of 1 keywords covered

dataSourceType1 / 1

191n/a{

291n/a "type": "string"

391n/a}

Body11 of 11 keywords covered

application/json11 / 11

CacheConfigSetter

19773{

26058 "properties": {

36824 "dataSourceID": {

46824 "format": "int64",

58111 "type": "integer"

66824 },

78312 "dataSourceUID": {

88312 "type": "string"

98312 },

10746 "enabled": {

11746 "type": "boolean"

12746 },

137711 "ttlQueriesMs": {

147711 "format": "int64",

15808 "type": "integer"

167711 },

177211 "ttlResourcesMs": {

187211 "format": "int64",

19776 "type": "integer"

207211 },

21715 "useDefaultTTL": {

22715 "type": "boolean"

23715 }

246058 },

2515515 "type": "object"

269773}

Responses0 of 3 documented received

codedescriptionhitsavg

200CacheConfigResponse0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1693ms

401Unauthorized40ms

POST /api/datasources/{dataSourceUID}/cache/clean

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

dataSourceUID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses0 of 2 documented received

codedescriptionhitsavg

200CacheConfigResponse0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found313ms

401Unauthorized710ms

POST /api/datasources/{dataSourceUID}/cache/disable

2parameters

2keywords

100%

Path Parameters1 of 1 keywords covered

dataSourceUID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Query Parameters1 of 1 keywords covered

dataSourceType1 / 1

119n/a{

219n/a "type": "string"

319n/a}

Responses0 of 2 documented received

codedescriptionhitsavg

200CacheConfigResponse0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found513ms

401Unauthorized510ms

POST /api/datasources/{dataSourceUID}/cache/enable

2parameters

2keywords

100%

Path Parameters1 of 1 keywords covered

dataSourceUID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Query Parameters1 of 1 keywords covered

dataSourceType1 / 1

124n/a{

224n/a "type": "string"

324n/a}

Responses0 of 2 documented received

codedescriptionhitsavg

200CacheConfigResponse0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found613ms

401Unauthorized410ms

folders 9 operations 9 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/folders

4parameters

7keywords

100%

Query Parameters7 of 7 keywords covered

limit2 / 2

#validinvalidschema

14656{

24656 "format": "int64",

34953 "type": "integer"

44656}

page2 / 2

14720{

24720 "format": "int64",

34918 "type": "integer"

44720}

parentUid1 / 1

155n/a{

255n/a "type": "string"

355n/a}

permission2 / 2

13617{

23617 "enum": [

331n/a "Edit",

45n/a "View"

53617 ],

653n/a "type": "string"

73617}

Responses3 of 4 documented received

codedescriptionhitsavg

200(empty)1004ms

401UnauthorizedError is returned when the request is not authenticated.231ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.74ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request183ms

404Not Found124ms

Examples3 / 3 used

Query

1000limit

1page

"View"permission

POST /api/folders

1parameter

6keywords

100%

Body6 of 6 keywords covered

application/json6 / 6

CreateFolderCommand

#validinvalidschema

19142{

26732 "properties": {

3417 "description": {

4417 "type": "string"

5417 },

6519 "parentUid": {

7519 "type": "string"

8519 },

97014 "title": {

107014 "type": "string"

117014 },

12678 "uid": {

13678 "type": "string"

14678 }

156732 },

1612310 "type": "object"

179142}

Responses3 of 6 documented received

codedescriptionhitsavg

200(empty)1844ms

400BadRequestError is returned when the request is invalid and it cannot be processed.924ms

401UnauthorizedError is returned when the request is not authenticated.90ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

409ConflictError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found114ms

41295ms

DELETE /api/folders/{folder_uid}

2parameters

2keywords

100%

Path Parameters1 of 1 keywords covered

folder_uid1 / 1

#validinvalidschema

1111n/a{

2111n/a "type": "string"

3111n/a}

Query Parameters1 of 1 keywords covered

forceDeleteRules1 / 1

14810{

24810 "type": "boolean"

34810}

Responses4 of 6 documented received

codedescriptionhitsavg

200(empty)191ms

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.471ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.624ms

500InternalServerError is a general error indicating something went wrong internally.13ms

Examples1 / 1 used

Query

falseforceDeleteRules

GET /api/folders/{folder_uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

folder_uid1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)375ms

401UnauthorizedError is returned when the request is not authenticated.641ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.44ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/folders/{folder_uid}

2parameters

8keywords

100%

Path Parameters1 of 1 keywords covered

folder_uid1 / 1

#validinvalidschema

1144n/a{

2144n/a "type": "string"

3144n/a}

Body7 of 7 keywords covered

application/json7 / 7

UpdateFolderCommand

110434{

210329 "properties": {

3755 "description": {

4755 "type": "string"

5755 },

66611 "overwrite": {

76611 "type": "boolean"

86611 },

96610 "title": {

106610 "type": "string"

116610 },

121138 "version": {

131138 "format": "int64",

141156 "type": "integer"

151138 }

1610329 },

171335 "type": "object"

1810434}

Responses3 of 7 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.353ms

401UnauthorizedError is returned when the request is not authenticated.91ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1004ms

409ConflictError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/folders/{folder_uid}/counts

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

folder_uid1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)365ms

401UnauthorizedError is returned when the request is not authenticated.631ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.64ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/folders/{folder_uid}/move

2parameters

4keywords

100%

Path Parameters1 of 1 keywords covered

folder_uid1 / 1

#validinvalidschema

1118n/a{

2118n/a "type": "string"

3118n/a}

Body3 of 3 keywords covered

application/json3 / 3

MoveFolderCommand

19319{

22812 "properties": {

32812 "parentUid": {

42812 "type": "string"

52812 }

62812 },

71057 "type": "object"

89319}

Responses4 of 5 documented received

codedescriptionhitsavg

200(empty)335ms

401UnauthorizedError is returned when the request is not authenticated.390ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.194ms

500InternalServerError is a general error indicating something went wrong internally.43ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request233ms

GET /api/folders/{folder_uid}/permissions

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

folder_uid1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)317ms

401UnauthorizedError is returned when the request is not authenticated.721ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.24ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/folders/{folder_uid}/permissions

2parameters

16keywords

100%

Path Parameters1 of 1 keywords covered

folder_uid1 / 1

#validinvalidschema

1176n/a{

2176n/a "type": "string"

3176n/a}

Body15 of 15 keywords covered

application/json15 / 15

UpdateDashboardACLCommand

17593{

23684 "properties": {

33684 "items": {

43675 "items": {

598273 "$ref": "#/components/schemas/DashboardACLUpdateItem"

63675 },

71119 "type": "array"

83684 }

93684 },

101599 "type": "object"

117593}

Referenced Components (2)13 of 13 keywords

DashboardACLUpdateItem11 of 11 keywords

198273{

279262 "properties": {

3132179 "permission": {

4132179 "$ref": "#/components/schemas/PermissionType"

5132179 },

615792 "role": {

715792 "enum": [

883n/a "None",

929n/a "Viewer",

1029n/a "Editor",

1116n/a "Admin"

1215792 ],

132445 "type": "string"

1415792 },

1516534 "teamId": {

1616534 "format": "int64",

1718910 "type": "integer"

1816534 },

19100186 "userId": {

20100186 "format": "int64",

212806 "type": "integer"

22100186 }

2379262 },

2436011 "type": "object"

2598273}

PermissionType2 of 2 keywords

1132179{

2132179 "format": "int64",

326942 "type": "integer"

4132179}

Responses4 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.367ms

401UnauthorizedError is returned when the request is not authenticated.101ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.284ms

500InternalServerError is a general error indicating something went wrong internally.36ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request993ms

health 1 operation 1 covered 0 partial 0 uncovered 0 not measured —

#

GET /api/health

0parameters

0keywords

—

Responses1 of 2 documented received

codedescriptionhitsavg

200healthResponse1291ms

503InternalServerError is a general error indicating something went wrong internally.0never seen

library_elements 7 operations 7 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/library-elements

9parameters

14keywords

100%

Query Parameters14 of 14 keywords covered

searchString1 / 1

#validinvalidschema

176n/a{

276n/a "type": "string"

376n/a}

kind3 / 3

15953{

25953 "enum": [

359n/a 1

45953 ],

58329 "format": "int64",

68527 "type": "integer"

75953}

sortDirection2 / 2

15457{

25457 "enum": [

343n/a "alpha-asc",

411n/a "alpha-desc"

55457 ],

6111n/a "type": "string"

75457}

typeFilter1 / 1

166n/a{

266n/a "type": "string"

366n/a}

excludeUid1 / 1

192n/a{

292n/a "type": "string"

392n/a}

folderFilter1 / 1

187n/a{

287n/a "type": "string"

387n/a}

folderFilterUIDs1 / 1

190n/a{

290n/a "type": "string"

390n/a}

perPage2 / 2

17720{

27720 "format": "int64",

37918 "type": "integer"

47720}

page2 / 2

16537{

26537 "format": "int64",

36735 "type": "integer"

46537}

Responses3 of 3 documented received

codedescriptionhitsavg

200(empty)1475ms

401UnauthorizedError is returned when the request is not authenticated.81ms

500InternalServerError is a general error indicating something went wrong internally.294ms

Examples2 / 2 used

Query

100perPage

1page

POST /api/library-elements

1parameter

11keywords

100%

Body11 of 11 keywords covered

application/json11 / 11

CreateLibraryElementCommand

#validinvalidschema

110751{

210346 "properties": {

313211 "folderId": {

413211 "format": "int64",

51376 "type": "integer"

613211 },

71168 "folderUid": {

81168 "type": "string"

91168 },

101069 "kind": {

111069 "enum": [

12106n/a 1

131069 ],

141078 "format": "int64",

151096 "type": "integer"

161069 },

171137 "model": {

181137 "type": "object"

191137 },

201175 "name": {

211175 "type": "string"

221175 },

231028 "uid": {

241028 "type": "string"

251028 }

2610346 },

271535 "type": "object"

2810751}

Responses4 of 6 documented received

codedescriptionhitsavg

200(empty)2022ms

400BadRequestError is returned when the request is invalid and it cannot be processed.1304ms

401UnauthorizedError is returned when the request is not authenticated.51ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.83ms

GET /api/library-elements/name/{library_element_name}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

library_element_name1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

404NotFoundError is returned when the requested resource was not found.23ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/library-elements/{library_element_uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

library_element_uid1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.570ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.453ms

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/library-elements/{library_element_uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

library_element_uid1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)255ms

401UnauthorizedError is returned when the request is not authenticated.721ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.83ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PATCH /api/library-elements/{library_element_uid}

2parameters

14keywords

100%

Path Parameters1 of 1 keywords covered

library_element_uid1 / 1

#validinvalidschema

173n/a{

273n/a "type": "string"

373n/a}

Body13 of 13 keywords covered

application/json13 / 13

PatchLibraryElementCommand

12149{

22044 "properties": {

3508 "folderId": {

4508 "format": "int64",

5526 "type": "integer"

6508 },

7535 "folderUid": {

8535 "type": "string"

9535 },

10498 "kind": {

11498 "enum": [

1249n/a 1

13498 ],

14498 "format": "int64",

15516 "type": "integer"

16498 },

17515 "model": {

18515 "type": "object"

19515 },

20505 "name": {

21505 "type": "string"

22505 },

23495 "uid": {

24495 "type": "string"

25495 },

26458 "version": {

27458 "format": "int64",

28476 "type": "integer"

29458 }

302044 },

31655 "type": "object"

322149}

Responses1 of 7 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.733ms

404NotFoundError is returned when the requested resource was not found.0never seen

412PreconditionFailedError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/library-elements/{library_element_uid}/connections/

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

library_element_uid1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)305ms

401UnauthorizedError is returned when the request is not authenticated.661ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.94ms

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

licensing 8 operations 8 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/licensing/check

0parameters

0keywords

—

Responses0 of 1 documented received

codedescriptionhitsavg

200(empty)0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found274ms

401Unauthorized751ms

GET /api/licensing/custom-permissions

0parameters

0keywords

—

Responses0 of 1 documented received

codedescriptionhitsavg

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found314ms

401Unauthorized711ms

GET /api/licensing/custom-permissions-csv

0parameters

0keywords

—

Responses0 of 1 documented received

codedescriptionhitsavg

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found334ms

401Unauthorized691ms

GET /api/licensing/refresh-stats

0parameters

0keywords

—

Responses0 of 2 documented received

codedescriptionhitsavg

200(empty)0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found323ms

401Unauthorized701ms

DELETE /api/licensing/token

1parameter

3keywords

100%

Body3 of 3 keywords covered

application/json3 / 3

DeleteTokenCommand

#validinvalidschema

15257{

22235 "properties": {

32235 "instance": {

42235 "type": "string"

52235 }

62235 },

78722 "type": "object"

85257}

Responses1 of 6 documented received

codedescriptionhitsavg

202AcceptedResponse0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.131ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

422UnprocessableEntityError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1023ms

GET /api/licensing/token

0parameters

0keywords

—

Responses0 of 1 documented received

codedescriptionhitsavg

200(empty)0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found314ms

401Unauthorized711ms

POST /api/licensing/token

1parameter

3keywords

100%

Body3 of 3 keywords covered

application/json3 / 3

DeleteTokenCommand

#validinvalidschema

19316{

2666 "properties": {

3666 "instance": {

4666 "type": "string"

5666 }

6666 },

79910 "type": "object"

89316}

Responses0 of 2 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1003ms

401Unauthorized150ms

POST /api/licensing/token/renew

1parameter

1keyword

100%

Body1 of 1 keywords covered

application/json1 / 1

#validinvalidschema

14356{

24356 "type": "object"

34356}

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.40ms

404NotFoundError is returned when the requested resource was not found.1054ms

migrations 13 operations 13 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/cloudmigration/migration

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)354ms

401UnauthorizedError is returned when the request is not authenticated.701ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/cloudmigration/migration

1parameter

3keywords

100%

Body3 of 3 keywords covered

application/json3 / 3

CloudMigrationSessionRequestDTO

#validinvalidschema

19117{

2699 "properties": {

3699 "authToken": {

4699 "type": "string"

5699 }

6699 },

71008 "type": "object"

89117}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.193ms

401UnauthorizedError is returned when the request is not authenticated.31ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.933ms

DELETE /api/cloudmigration/migration/{uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

16n/a{

26n/a "type": "string"

36n/a}

Responses1 of 4 documented received

codedescriptionhitsavg

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.10ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found57ms

GET /api/cloudmigration/migration/{uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.53ms

401UnauthorizedError is returned when the request is not authenticated.660ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found313ms

POST /api/cloudmigration/migration/{uid}/snapshot

2parameters

6keywords

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1132n/a{

2132n/a "type": "string"

3132n/a}

Body5 of 5 keywords covered

application/json5 / 5

CreateSnapshotRequestDTO

16065{

23742 "properties": {

33742 "resourceTypes": {

4379 "items": {

59815 "enum": [

616n/a "DASHBOARD",

75n/a "DATASOURCE",

88n/a "FOLDER",

95n/a "LIBRARY_ELEMENT",

1015n/a "ALERT_RULE",

114n/a "ALERT_RULE_GROUP",

128n/a "CONTACT_POINT",

136n/a "NOTIFICATION_POLICY",

148n/a "NOTIFICATION_TEMPLATE",

1511n/a "MUTE_TIMING",

1612n/a "PLUGIN"

179815 ],

181085 "type": "string"

19379 },

204633 "type": "array"

213742 }

223742 },

2310223 "type": "object"

246065}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.1153ms

401UnauthorizedError is returned when the request is not authenticated.111ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found63ms

GET /api/cloudmigration/migration/{uid}/snapshot/{snapshotUid}

7parameters

9keywords

100%

Path Parameters2 of 2 keywords covered

uid1 / 1

#validinvalidschema

1157n/a{

2157n/a "type": "string"

3157n/a}

snapshotUid1 / 1

1157n/a{

2157n/a "type": "string"

3157n/a}

Query Parameters7 of 7 keywords covered

resultPage2 / 2

15815{

25815 "format": "int64",

36013 "type": "integer"

45815}

resultLimit2 / 2

16915{

26915 "format": "int64",

37113 "type": "integer"

46915}

resultSortColumn1 / 1

164n/a{

264n/a "type": "string"

364n/a}

resultSortOrder1 / 1

155n/a{

255n/a "type": "string"

355n/a}

errorsOnly1 / 1

18110{

28110 "type": "boolean"

38110}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.244ms

401UnauthorizedError is returned when the request is not authenticated.541ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found793ms

Examples5 / 5 used

Query

1resultPage

100resultLimit

"default"resultSortColumn

"ASC"resultSortOrder

falseerrorsOnly

POST /api/cloudmigration/migration/{uid}/snapshot/{snapshotUid}/cancel

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

uid1 / 1

#validinvalidschema

1103n/a{

2103n/a "type": "string"

3103n/a}

snapshotUid1 / 1

1103n/a{

2103n/a "type": "string"

3103n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.233ms

401UnauthorizedError is returned when the request is not authenticated.501ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.304ms

POST /api/cloudmigration/migration/{uid}/snapshot/{snapshotUid}/upload

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

uid1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

snapshotUid1 / 1

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.313ms

401UnauthorizedError is returned when the request is not authenticated.601ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found113ms

GET /api/cloudmigration/migration/{uid}/snapshots

4parameters

6keywords

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1145n/a{

2145n/a "type": "string"

3145n/a}

Query Parameters5 of 5 keywords covered

page2 / 2

13663{

23663 "format": "int64",

34059 "type": "integer"

43663}

limit2 / 2

14258{

24258 "format": "int64",

34654 "type": "integer"

44258}

sort1 / 1

149n/a{

249n/a "type": "string"

349n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)923ms

400BadRequestError is returned when the request is invalid and it cannot be processed.423ms

401UnauthorizedError is returned when the request is not authenticated.111ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples2 / 2 used

Query

1page

100limit

GET /api/cloudmigration/resources/dependencies

0parameters

0keywords

—

Responses1 of 1 documented received

codedescriptionhitsavg

200(empty)253ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized800ms

GET /api/cloudmigration/token

0parameters

0keywords

—

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.651ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.3828ms

POST /api/cloudmigration/token

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.720ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.3129ms

DELETE /api/cloudmigration/token/{uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

13n/a{

23n/a "type": "string"

33n/a}

Responses1 of 5 documented received

codedescriptionhitsavg

204(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.327ms

org 14 operations 14 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/org

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)384ms

401UnauthorizedError is returned when the request is not authenticated.671ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/org

1parameter

3keywords

100%

Body3 of 3 keywords covered

application/json3 / 3

UpdateOrgForm

#validinvalidschema

19514{

2695 "properties": {

3695 "name": {

4695 "type": "string"

5695 }

6695 },

71009 "type": "object"

89514}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.3223ms

400BadRequestError is returned when the request is invalid and it cannot be processed.753ms

401UnauthorizedError is returned when the request is not authenticated.111ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/org/address

1parameter

8keywords

100%

Body8 of 8 keywords covered

application/json8 / 8

UpdateOrgAddressForm

#validinvalidschema

16278{

23667 "properties": {

37013 "address1": {

47013 "type": "string"

57013 },

66012 "address2": {

76012 "type": "string"

86012 },

94921 "city": {

104921 "type": "string"

114921 },

124531 "country": {

134531 "type": "string"

144531 },

154719 "state": {

164719 "type": "string"

174719 },

184034 "zipcode": {

194034 "type": "string"

204034 }

213667 },

2212911 "type": "object"

236278}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.617ms

400BadRequestError is returned when the request is invalid and it cannot be processed.794ms

401UnauthorizedError is returned when the request is not authenticated.131ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/org/invites

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)434ms

401UnauthorizedError is returned when the request is not authenticated.620ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/org/invites

1parameter

7keywords

100%

Body7 of 7 keywords covered

application/json7 / 7

AddInviteForm

#validinvalidschema

110237{

28131 "properties": {

3946 "loginOrEmail": {

4946 "type": "string"

5946 },

6576 "name": {

7576 "type": "string"

8576 },

9788 "role": {

10788 "enum": [

1145n/a "None",

1217n/a "Viewer",

133n/a "Editor",

1413n/a "Admin"

15788 ],

16815 "type": "string"

17788 },

188413 "sendEmail": {

198413 "type": "boolean"

208413 }

218131 },

221336 "type": "object"

2310237}

Responses3 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.4020ms

400BadRequestError is returned when the request is invalid and it cannot be processed.923ms

401UnauthorizedError is returned when the request is not authenticated.121ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

412(empty)0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/org/invites/{invitation_code}/revoke

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

invitation_code1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.601ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.423ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/org/preferences

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)384ms

401UnauthorizedError is returned when the request is not authenticated.671ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

PATCH /api/org/preferences

1parameter

19keywords

100%

Body19 of 19 keywords covered

application/json19 / 19

PatchPrefsCmd

#validinvalidschema

110776{

28268 "properties": {

31278 "homeDashboardId": {

41278 "format": "int64",

51296 "type": "integer"

61278 },

71185 "homeDashboardUID": {

81185 "type": "string"

91185 },

101175 "language": {

111175 "type": "string"

121175 },

1310516 "navbar": {

1410516 "$ref": "#/components/schemas/NavbarPreference"

1510516 },

1610117 "queryHistory": {

1710117 "$ref": "#/components/schemas/QueryHistoryPreference"

1810117 },

191088 "theme": {

201088 "enum": [

2171n/a "light",

2237n/a "dark"

231088 ],

241115 "type": "string"

251088 },

26815 "timezone": {

27815 "type": "string"

28815 },

29835 "weekStart": {

30835 "type": "string"

31835 }

328268 },

331758 "type": "object"

3410776}

Referenced Components (2)9 of 9 keywords

NavbarPreference5 of 5 keywords

110516{

29011 "properties": {

39011 "bookmarkUrls": {

4905 "items": {

51405 "type": "string"

6905 },

7956 "type": "array"

89011 }

99011 },

101165 "type": "object"

1110516}

QueryHistoryPreference4 of 4 keywords

110117{

2715 "properties": {

3715 "homeTab": {

4715 "type": "string"

5715 }

6715 },

710612 "type": "object"

810117}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.5522ms

400BadRequestError is returned when the request is invalid and it cannot be processed.703ms

401UnauthorizedError is returned when the request is not authenticated.611ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

422Unprocessable Entity64ms

404Not Found24ms

Examples1 / 1 used

Body: application/json

0PatchPrefsCmd.homeDashboardId

PUT /api/org/preferences

1parameter

19keywords

100%

Body19 of 19 keywords covered

application/json19 / 19

UpdatePrefsCmd

#validinvalidschema

111970{

210562 "properties": {

31299 "homeDashboardId": {

41299 "format": "int64",

51317 "type": "integer"

61299 },

71375 "homeDashboardUID": {

81375 "type": "string"

91375 },

101367 "language": {

111367 "type": "string"

121367 },

1312716 "navbar": {

1412716 "$ref": "#/components/schemas/NavbarPreference"

1512716 },

1613111 "queryHistory": {

1713111 "$ref": "#/components/schemas/QueryHistoryPreference"

1813111 },

191387 "theme": {

201387 "enum": [

2176n/a "light",

2235n/a "dark",

2327n/a "system"

241387 ],

251405 "type": "string"

261387 },

271275 "timezone": {

281275 "type": "string"

291275 },

301245 "weekStart": {

311245 "type": "string"

321245 }

3310562 },

341818 "type": "object"

3511970}

Referenced Components (2)9 of 9 keywords

NavbarPreference5 of 5 keywords

112716{

26710 "properties": {

36710 "bookmarkUrls": {

4675 "items": {

5255 "type": "string"

6675 },

7725 "type": "array"

86710 }

96710 },

101376 "type": "object"

1112716}

QueryHistoryPreference4 of 4 keywords

113111{

2775 "properties": {

3775 "homeTab": {

4775 "type": "string"

5775 }

6775 },

71366 "type": "object"

813111}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.9422ms

400BadRequestError is returned when the request is invalid and it cannot be processed.593ms

401UnauthorizedError is returned when the request is not authenticated.121ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

422Unprocessable Entity305ms

Examples1 / 1 used

Body: application/json

0UpdatePrefsCmd.homeDashboardId

GET /api/org/users

2parameters

3keywords

100%

Query Parameters3 of 3 keywords covered

query1 / 1

#validinvalidschema

146n/a{

246n/a "type": "string"

346n/a}

limit2 / 2

12072{

22072 "format": "int64",

32369 "type": "integer"

42072}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)1064ms

401UnauthorizedError is returned when the request is not authenticated.180ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/org/users

1parameter

5keywords

100%

Body5 of 5 keywords covered

application/json5 / 5

AddOrgUserCommand

#validinvalidschema

18629{

27319 "properties": {

3795 "loginOrEmail": {

4795 "type": "string"

5795 },

67214 "role": {

77214 "enum": [

852n/a "None",

91n/a "Viewer",

1011n/a "Editor",

118n/a "Admin"

127214 ],

13815 "type": "string"

147214 }

157319 },

1610510 "type": "object"

178629}

Responses1 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.30ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request683ms

404Not Found553ms

GET /api/org/users/lookup

2parameters

3keywords

100%

Query Parameters3 of 3 keywords covered

query1 / 1

#validinvalidschema

144n/a{

244n/a "type": "string"

344n/a}

limit2 / 2

12478{

22478 "format": "int64",

32775 "type": "integer"

42478}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)1105ms

401UnauthorizedError is returned when the request is not authenticated.141ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/org/users/{user_id}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

167{

267 "format": "int64",

376 "type": "integer"

467}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.73ms

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.63ms

PATCH /api/org/users/{user_id}

2parameters

6keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

1227{

2227 "format": "int64",

3236 "type": "integer"

4227}

Body4 of 4 keywords covered

application/json4 / 4

UpdateOrgUserCommand

11511{

2146 "properties": {

3146 "role": {

4146 "enum": [

511n/a "None",

61n/a "Viewer",

71n/a "Editor",

81n/a "Admin"

9146 ],

10155 "type": "string"

11146 }

12146 },

13215 "type": "object"

141511}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.223ms

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.73ms

orgs 12 operations 12 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/orgs

4parameters

6keywords

100%

Query Parameters6 of 6 keywords covered

page2 / 2

#validinvalidschema

14152{

24152 "format": "int64",

34350 "type": "integer"

44152}

perpage2 / 2

14447{

24447 "format": "int64",

34645 "type": "integer"

44447}

name1 / 1

159n/a{

259n/a "type": "string"

359n/a}

query1 / 1

152n/a{

252n/a "type": "string"

352n/a}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)1194ms

401UnauthorizedError is returned when the request is not authenticated.281ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

409ConflictError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples2 / 2 used

Query

1page

1000perpage

POST /api/orgs

1parameter

3keywords

100%

Body3 of 3 keywords covered

application/json3 / 3

CreateOrgCommand

#validinvalidschema

17933{

24619 "properties": {

34619 "name": {

44619 "type": "string"

54619 }

64619 },

79814 "type": "object"

87933}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)1121ms

401UnauthorizedError is returned when the request is not authenticated.151ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

409ConflictError204ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request724ms

GET /api/orgs/name/{org_name}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

org_name1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)23ms

401UnauthorizedError is returned when the request is not authenticated.760ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found274ms

DELETE /api/orgs/{org_id}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

org_id2 / 2

#validinvalidschema

110410{

210410 "format": "int64",

31059 "type": "integer"

410410}

Responses3 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.120ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.103ms

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.924ms

GET /api/orgs/{org_id}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

org_id2 / 2

#validinvalidschema

11069{

21069 "format": "int64",

31078 "type": "integer"

41069}

Responses3 of 4 documented received

codedescriptionhitsavg

200(empty)124ms

401UnauthorizedError is returned when the request is not authenticated.481ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.103ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found454ms

PUT /api/orgs/{org_id}

2parameters

5keywords

100%

Path Parameters2 of 2 keywords covered

org_id2 / 2

#validinvalidschema

111810{

211810 "format": "int64",

31199 "type": "integer"

411810}

Body3 of 3 keywords covered

application/json3 / 3

UpdateOrgForm

19127{

26811 "properties": {

36811 "name": {

46811 "type": "string"

56811 }

66811 },

710216 "type": "object"

89127}

Responses4 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.2223ms

400BadRequestError is returned when the request is invalid and it cannot be processed.884ms

401UnauthorizedError is returned when the request is not authenticated.81ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.103ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/orgs/{org_id}/address

2parameters

10keywords

100%

Path Parameters2 of 2 keywords covered

org_id2 / 2

#validinvalidschema

115311{

215311 "format": "int64",

315410 "type": "integer"

415311}

Body8 of 8 keywords covered

application/json8 / 8

UpdateOrgAddressForm

111241{

24734 "properties": {

3648 "address1": {

4648 "type": "string"

5648 },

6526 "address2": {

7526 "type": "string"

8526 },

9595 "city": {

10595 "type": "string"

11595 },

12545 "country": {

13545 "type": "string"

14545 },

15576 "state": {

16576 "type": "string"

17576 },

18559 "zipcode": {

19559 "type": "string"

20559 }

214734 },

221467 "type": "object"

2311241}

Responses4 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.1097ms

400BadRequestError is returned when the request is invalid and it cannot be processed.403ms

401UnauthorizedError is returned when the request is not authenticated.41ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.113ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/orgs/{org_id}/users

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

org_id2 / 2

#validinvalidschema

11087{

21087 "format": "int64",

31096 "type": "integer"

41087}

Responses3 of 4 documented received

codedescriptionhitsavg

200(empty)884ms

401UnauthorizedError is returned when the request is not authenticated.200ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.73ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/orgs/{org_id}/users

2parameters

7keywords

100%

Path Parameters2 of 2 keywords covered

org_id2 / 2

#validinvalidschema

11307{

21307 "format": "int64",

31316 "type": "integer"

41307}

Body5 of 5 keywords covered

application/json5 / 5

AddOrgUserCommand

111119{

24912 "properties": {

3505 "loginOrEmail": {

4505 "type": "string"

5505 },

6477 "role": {

7477 "enum": [

828n/a "None",

910n/a "Viewer",

103n/a "Editor",

116n/a "Admin"

12477 ],

13495 "type": "string"

14477 }

154912 },

161237 "type": "object"

1711119}

Responses2 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.10ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.73ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request1143ms

404Not Found155ms

GET /api/orgs/{org_id}/users/search

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

org_id2 / 2

#validinvalidschema

110312{

210312 "format": "int64",

310510 "type": "integer"

410312}

Responses3 of 4 documented received

codedescriptionhitsavg

200(empty)854ms

401UnauthorizedError is returned when the request is not authenticated.181ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.123ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/orgs/{org_id}/users/{user_id}

2parameters

4keywords

100%

Path Parameters4 of 4 keywords covered

org_id2 / 2

#validinvalidschema

1177{

2177 "format": "int64",

3186 "type": "integer"

4177}

user_id2 / 2

1177{

2177 "format": "int64",

3186 "type": "integer"

4177}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.73ms

500InternalServerError is a general error indicating something went wrong internally.104ms

Undocumented - not in spec

codedescriptionhitsavg

404Not Found73ms

PATCH /api/orgs/{org_id}/users/{user_id}

3parameters

8keywords

100%

Path Parameters4 of 4 keywords covered

org_id2 / 2

#validinvalidschema

1327{

2327 "format": "int64",

3336 "type": "integer"

4327}

user_id2 / 2

1327{

2327 "format": "int64",

3336 "type": "integer"

4327}

Body4 of 4 keywords covered

application/json4 / 4

UpdateOrgUserCommand

12511{

2246 "properties": {

3246 "role": {

4246 "enum": [

521n/a "None",

61n/a "Viewer",

71n/a "Editor",

81n/a "Admin"

9246 ],

10255 "type": "string"

11246 }

12246 },

13315 "type": "object"

142511}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.153ms

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.73ms

500InternalServerError is a general error indicating something went wrong internally.103ms

Undocumented - not in spec

codedescriptionhitsavg

404Not Found73ms

playlists 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/playlists

2parameters

3keywords

100%

Query Parameters3 of 3 keywords covered

query1 / 1

#validinvalidschema

152n/a{

252n/a "type": "string"

352n/a}

limit2 / 2

12364{

22364 "format": "int64",

32958 "type": "integer"

42364}

Responses1 of 2 documented received

codedescriptionhitsavg

200(empty)1135ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized111ms

POST /api/playlists

1parameter

17keywords

100%

Body17 of 17 keywords covered

application/json17 / 17

CreatePlaylistCommand

#validinvalidschema

112172{

211165 "properties": {

31615 "interval": {

41615 "type": "string"

51615 },

611755 "items": {

711750 "items": {

819361 "$ref": "#/components/schemas/PlaylistItem"

911750 },

101675 "type": "array"

1111755 },

1215910 "name": {

1315910 "type": "string"

1415910 }

1511165 },

161867 "type": "object"

1712172}

Referenced Components (1)12 of 12 keywords

PlaylistItem12 of 12 keywords

119361{

215956 "properties": {

38322 "Id": {

48322 "format": "int64",

58520 "type": "integer"

68322 },

79111 "PlaylistId": {

89111 "format": "int64",

9939 "type": "integer"

109111 },

1114911 "order": {

1214911 "format": "int64",

131546 "type": "integer"

1414911 },

158619 "title": {

168619 "type": "string"

178619 },

18865 "type": {

19865 "type": "string"

20865 },

211655 "value": {

221655 "type": "string"

231655 }

2415956 },

252495 "type": "object"

2619361}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)6022ms

401UnauthorizedError is returned when the request is not authenticated.131ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request1273ms

DELETE /api/playlists/{uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

177n/a{

277n/a "type": "string"

377n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.128ms

401UnauthorizedError is returned when the request is not authenticated.170ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.594ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/playlists/{uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)24ms

401UnauthorizedError is returned when the request is not authenticated.580ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.454ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/playlists/{uid}

2parameters

19keywords

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1204n/a{

2204n/a "type": "string"

3204n/a}

Body18 of 18 keywords covered

application/json18 / 18

UpdatePlaylistCommand

111681{

25572 "properties": {

31107 "interval": {

41107 "type": "string"

51107 },

65656 "items": {

75651 "items": {

862103 "$ref": "#/components/schemas/PlaylistItem"

95651 },

101075 "type": "array"

115656 },

121085 "name": {

131085 "type": "string"

141085 },

151025 "uid": {

161025 "type": "string"

171025 }

185572 },

191889 "type": "object"

2011681}

Referenced Components (1)12 of 12 keywords

PlaylistItem12 of 12 keywords

162103{

24998 "properties": {

38618 "Id": {

48618 "format": "int64",

58816 "type": "integer"

68618 },

79210 "PlaylistId": {

89210 "format": "int64",

9966 "type": "integer"

109210 },

118529 "order": {

128529 "format": "int64",

138727 "type": "integer"

148529 },

157432 "title": {

167432 "type": "string"

177432 },

189414 "type": {

199414 "type": "string"

209414 },

217047 "value": {

227047 "type": "string"

237047 }

244998 },

251605 "type": "object"

2662103}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.51ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.134ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request1864ms

GET /api/playlists/{uid}/items

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)24ms

401UnauthorizedError is returned when the request is not authenticated.590ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.444ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

provisioning 31 operations 31 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/v1/provisioning/alert-rules

0parameters

0keywords

—

Responses1 of 2 documented received

codedescriptionhitsavg

200ProvisionedAlertRules324ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized730ms

POST /api/v1/provisioning/alert-rules

2parameters

73keywords

100%

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

#validinvalidschema

1362n/a{

2362n/a "type": "string"

3362n/a}

Body72 of 72 keywords covered

application/json72 / 72

ProvisionedAlertRule

1166255{

2175241 "properties": {

336110 "annotations": {

43395 "additionalProperties": {

53575 "type": "string"

63395 },

73665 "type": "object"

836110 },

94105 "condition": {

104105 "type": "string"

114105 },

1236352 "data": {

1336347 "items": {

1454647 "$ref": "#/components/schemas/AlertQuery"

1536347 },

164105 "type": "array"

1736352 },

184096 "execErrState": {

194096 "enum": [

20371n/a "OK",

2123n/a "Alerting",

2215n/a "Error"

234096 ],

244105 "type": "string"

254096 },

264105 "folderUID": {

274105 "type": "string"

284105 },

294096 "for": {

304091 "format": "duration",

314105 "type": "string"

324096 },

333338 "id": {

343338 "format": "int64",

353356 "type": "integer"

363338 },

373356 "isPaused": {

383356 "type": "boolean"

393356 },

403386 "keep_firing_for": {

413381 "format": "duration",

423395 "type": "string"

433386 },

4432811 "labels": {

453265 "additionalProperties": {

463335 "type": "string"

473265 },

483336 "type": "object"

4932811 },

503298 "missingSeriesEvalsToResolve": {

513298 "format": "int64",

523316 "type": "integer"

533298 },

544096 "noDataState": {

554096 "enum": [

56350n/a "Alerting",

5726n/a "NoData",

5833n/a "OK"

594096 ],

604105 "type": "string"

614096 },

6228557 "notification_settings": {

6328557 "$ref": "#/components/schemas/AlertRuleNotificationSettings"

6428557 },

654078 "orgID": {

664078 "format": "int64",

674096 "type": "integer"

684078 },

693386 "provenance": {

703386 "$ref": "#/components/schemas/Provenance"

713386 },

7231422 "record": {

7331422 "$ref": "#/components/schemas/Record"

7431422 },

754087 "ruleGroup": {

764091 "maxLength": 190,

774091 "minLength": 1,

784105 "type": "string"

794087 },

804087 "title": {

814091 "maxLength": 190,

824091 "minLength": 1,

834105 "type": "string"

844087 },

853278 "uid": {

863291 "maxLength": 40,

873291 "minLength": 1,

883282 "pattern": "^[a-zA-Z0-9-_]+$",

893305 "type": "string"

903278 }

91175241 },

924079 "required": [

934151 "orgID",

944151 "folderUID",

954151 "ruleGroup",

964151 "title",

974151 "condition",

984151 "data",

994151 "noDataState",

1004151 "execErrState",

1014151 "for"

1024079 ],

1034165 "type": "object"

104166255}

Referenced Components (6)39 of 39 keywords

AlertQuery8 of 8 keywords

154647{

249542 "properties": {

34595 "datasourceUid": {

44595 "type": "string"

54595 },

64765 "model": {

74765 "type": "object"

84765 },

94485 "queryType": {

104485 "type": "string"

114485 },

124305 "refId": {

134305 "type": "string"

144305 },

1544222 "relativeTimeRange": {

1644222 "$ref": "#/components/schemas/RelativeTimeRange"

1744222 }

1849542 },

195885 "type": "object"

2054647}

AlertRuleNotificationSettings15 of 15 keywords

128557{

228651 "properties": {

331111 "active_time_intervals": {

43116 "items": {

53198 "type": "string"

63116 },

73175 "type": "array"

831111 },

931110 "group_by": {

103115 "items": {

119305 "type": "string"

123115 },

133165 "type": "array"

1431110 },

153165 "group_interval": {

163165 "type": "string"

173165 },

183145 "group_wait": {

193145 "type": "string"

203145 },

2130910 "mute_time_intervals": {

223095 "items": {

233105 "type": "string"

243095 },

253145 "type": "array"

2630910 },

273315 "receiver": {

283315 "type": "string"

293315 },

303125 "repeat_interval": {

313125 "type": "string"

323125 }

3328651 },

343361 "required": [

353361 "receiver"

363361 ],

373375 "type": "object"

3828557}

Duration2 of 2 keywords

179517{

279517 "format": "int64",

380012 "type": "integer"

479517}

Provenance1 of 1 keywords

13386{

23386 "type": "string"

33386}

Record8 of 8 keywords

131422{

231615 "properties": {

33255 "from": {

43255 "type": "string"

53255 },

63255 "metric": {

73255 "type": "string"

83255 },

93205 "target_datasource_uid": {

103205 "type": "string"

113205 }

1231615 },

133292 "required": [

143301 "metric",

153301 "from"

163292 ],

173315 "type": "object"

1831422}

RelativeTimeRange5 of 5 keywords

144222{

241817 "properties": {

33898 "from": {

43898 "$ref": "#/components/schemas/Duration"

53898 },

64069 "to": {

74069 "$ref": "#/components/schemas/Duration"

84069 }

941817 },

104595 "type": "object"

1144222}

Responses1 of 3 documented received

codedescriptionhitsavg

201ProvisionedAlertRule0never seen

400ValidationError4433ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized91ms

Examples20 / 20 used

Body: application/json

{ "runbook_url": "https://supercoolrunbook.com/page/13" }ProvisionedAlertRule.annotations

"A"ProvisionedAlertRule.condition

[ { "datasourceUid": "__expr__", "model": { "conditions": [ { "evaluator": { "params": [ 0, 0 ], "type": "gt" }, "operator": { "type": "and" }, "query": { "params": [] }, "reducer": { "params": [], "type": "avg" }, "type": "query" } ], "datasource": { "type": "__expr__", "uid": "__expr__" }, "expression": "1 == 1", "hide": false, "intervalMs": 1000, "maxDataPoints": 43200, "refId": "A", "type": "math" }, "queryType": "", "refId": "A", "relativeTimeRange": { "from": 0, "to": 0 } } ]ProvisionedAlertRule.data

"project_x"ProvisionedAlertRule.folderUID

falseProvisionedAlertRule.isPaused

{ "team": "sre-team-1" }ProvisionedAlertRule.labels

2ProvisionedAlertRule.missingSeriesEvalsToResolve

[ "maintenance" ]AlertRuleNotificationSettings.active_time_intervals

[ "alertname", "grafana_folder" ]AlertRuleNotificationSettings.group_by

[ "alertname", "grafana_folder", "cluster" ]AlertRuleNotificationSettings.group_by

"5m"AlertRuleNotificationSettings.group_interval

"30s"AlertRuleNotificationSettings.group_wait

[ "maintenance" ]AlertRuleNotificationSettings.mute_time_intervals

"grafana-default-email"AlertRuleNotificationSettings.receiver

"4h"AlertRuleNotificationSettings.repeat_interval

"A"Record.from

"grafana_alerts_ratio"Record.metric

"my-prom"Record.target_datasource_uid

"eval_group_1"ProvisionedAlertRule.ruleGroup

"Always firing"ProvisionedAlertRule.title

GET /api/v1/provisioning/alert-rules/export

5parameters

7keywords

100%

Query Parameters7 of 7 keywords covered

download1 / 1

#validinvalidschema

14359{

24359 "type": "boolean"

34359}

format2 / 2

14533{

24533 "enum": [

322n/a "yaml",

412n/a "json",

511n/a "hcl"

64533 ],

778n/a "type": "string"

84533}

folderUid2 / 2

184n/a{

284n/a "items": {

3146n/a "type": "string"

484n/a },

584n/a "type": "array"

684n/a}

group1 / 1

159n/a{

259n/a "type": "string"

359n/a}

ruleUid1 / 1

153n/a{

253n/a "type": "string"

353n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

200AlertingFileExport0never seen

403ForbiddenError0never seen

404 Not found.1083ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request214ms

401Unauthorized170ms

Examples2 / 2 used

Query

falsedownload

"yaml"format

DELETE /api/v1/provisioning/alert-rules/{UID}

2parameters

2keywords

100%

Path Parameters1 of 1 keywords covered

UID1 / 1

#validinvalidschema

1107n/a{

2107n/a "type": "string"

3107n/a}

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

146n/a{

246n/a "type": "string"

346n/a}

Responses1 of 2 documented received

codedescriptionhitsavg

204 The alert rule was deleted successfully.263ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized810ms

GET /api/v1/provisioning/alert-rules/{UID}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

UID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

200ProvisionedAlertRule0never seen

403ForbiddenError0never seen

404 Not found.373ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized650ms

PUT /api/v1/provisioning/alert-rules/{UID}

3parameters

74keywords

100%

Path Parameters1 of 1 keywords covered

UID1 / 1

#validinvalidschema

1452n/a{

2452n/a "type": "string"

3452n/a}

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

1372n/a{

2372n/a "type": "string"

3372n/a}

Body72 of 72 keywords covered

application/json72 / 72

ProvisionedAlertRule

1158254{

2167240 "properties": {

334810 "annotations": {

43445 "additionalProperties": {

53605 "type": "string"

63445 },

73535 "type": "object"

834810 },

94015 "condition": {

104015 "type": "string"

114015 },

1235452 "data": {

1335447 "items": {

1462947 "$ref": "#/components/schemas/AlertQuery"

1535447 },

164015 "type": "array"

1735452 },

184006 "execErrState": {

194006 "enum": [

20363n/a "OK",

2114n/a "Alerting",

2223n/a "Error"

234006 ],

244015 "type": "string"

254006 },

264015 "folderUID": {

274015 "type": "string"

284015 },

294006 "for": {

304001 "format": "duration",

314015 "type": "string"

324006 },

333438 "id": {

343438 "format": "int64",

353456 "type": "integer"

363438 },

373395 "isPaused": {

383395 "type": "boolean"

393395 },

403446 "keep_firing_for": {

413441 "format": "duration",

423455 "type": "string"

433446 },

4433210 "labels": {

453235 "additionalProperties": {

463335 "type": "string"

473235 },

483375 "type": "object"

4933210 },

503348 "missingSeriesEvalsToResolve": {

513348 "format": "int64",

523366 "type": "integer"

533348 },

544006 "noDataState": {

554006 "enum": [

56347n/a "Alerting",

578n/a "NoData",

5845n/a "OK"

594006 ],

604015 "type": "string"

614006 },

6228456 "notification_settings": {

6328456 "$ref": "#/components/schemas/AlertRuleNotificationSettings"

6428456 },

653988 "orgID": {

663988 "format": "int64",

674006 "type": "integer"

683988 },

693365 "provenance": {

703365 "$ref": "#/components/schemas/Provenance"

713365 },

7231822 "record": {

7331822 "$ref": "#/components/schemas/Record"

7431822 },

753997 "ruleGroup": {

764001 "maxLength": 190,

774001 "minLength": 1,

784015 "type": "string"

793997 },

803997 "title": {

814001 "maxLength": 190,

824001 "minLength": 1,

834015 "type": "string"

843997 },

853288 "uid": {

863301 "maxLength": 40,

873301 "minLength": 1,

883292 "pattern": "^[a-zA-Z0-9-_]+$",

893315 "type": "string"

903288 }

91167240 },

923989 "required": [

934061 "orgID",

944061 "folderUID",

954061 "ruleGroup",

964061 "title",

974061 "condition",

984061 "data",

994061 "noDataState",

1004061 "execErrState",

1014061 "for"

1023989 ],

1034075 "type": "object"

104158254}

Referenced Components (6)39 of 39 keywords

AlertQuery8 of 8 keywords

162947{

254142 "properties": {

35035 "datasourceUid": {

45035 "type": "string"

55035 },

65175 "model": {

75175 "type": "object"

85175 },

95155 "queryType": {

105155 "type": "string"

115155 },

124765 "refId": {

134765 "type": "string"

144765 },

1548322 "relativeTimeRange": {

1648322 "$ref": "#/components/schemas/RelativeTimeRange"

1748322 }

1854142 },

196715 "type": "object"

2062947}

AlertRuleNotificationSettings15 of 15 keywords

128456{

228550 "properties": {

331210 "active_time_intervals": {

43125 "items": {

53175 "type": "string"

63125 },

73175 "type": "array"

831210 },

931510 "group_by": {

103155 "items": {

119795 "type": "string"

123155 },

133205 "type": "array"

1431510 },

153195 "group_interval": {

163195 "type": "string"

173195 },

183195 "group_wait": {

193195 "type": "string"

203195 },

2131210 "mute_time_intervals": {

223125 "items": {

233295 "type": "string"

243125 },

253175 "type": "array"

2631210 },

273295 "receiver": {

283295 "type": "string"

293295 },

303175 "repeat_interval": {

313175 "type": "string"

323175 }

3328550 },

343341 "required": [

353341 "receiver"

363341 ],

373355 "type": "object"

3828456}

Duration2 of 2 keywords

178417{

278417 "format": "int64",

378912 "type": "integer"

478417}

Provenance1 of 1 keywords

13365{

23365 "type": "string"

33365}

Record8 of 8 keywords

131822{

232015 "properties": {

33295 "from": {

43295 "type": "string"

53295 },

63295 "metric": {

73295 "type": "string"

83295 },

93265 "target_datasource_uid": {

103265 "type": "string"

113265 }

1232015 },

133332 "required": [

143341 "metric",

153341 "from"

163332 ],

173355 "type": "object"

1831822}

RelativeTimeRange5 of 5 keywords

148322{

239817 "properties": {

33898 "from": {

43898 "$ref": "#/components/schemas/Duration"

53898 },

63959 "to": {

73959 "$ref": "#/components/schemas/Duration"

83959 }

939817 },

105005 "type": "object"

1148322}

Responses1 of 3 documented received

codedescriptionhitsavg

200ProvisionedAlertRule0never seen

400ValidationError4333ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized191ms

Examples20 / 20 used

Body: application/json

{ "runbook_url": "https://supercoolrunbook.com/page/13" }ProvisionedAlertRule.annotations

"A"ProvisionedAlertRule.condition

[ { "datasourceUid": "__expr__", "model": { "conditions": [ { "evaluator": { "params": [ 0, 0 ], "type": "gt" }, "operator": { "type": "and" }, "query": { "params": [] }, "reducer": { "params": [], "type": "avg" }, "type": "query" } ], "datasource": { "type": "__expr__", "uid": "__expr__" }, "expression": "1 == 1", "hide": false, "intervalMs": 1000, "maxDataPoints": 43200, "refId": "A", "type": "math" }, "queryType": "", "refId": "A", "relativeTimeRange": { "from": 0, "to": 0 } } ]ProvisionedAlertRule.data

"project_x"ProvisionedAlertRule.folderUID

falseProvisionedAlertRule.isPaused

{ "team": "sre-team-1" }ProvisionedAlertRule.labels

2ProvisionedAlertRule.missingSeriesEvalsToResolve

[ "maintenance" ]AlertRuleNotificationSettings.active_time_intervals

[ "alertname", "grafana_folder" ]AlertRuleNotificationSettings.group_by

[ "alertname", "grafana_folder", "cluster" ]AlertRuleNotificationSettings.group_by

"5m"AlertRuleNotificationSettings.group_interval

"30s"AlertRuleNotificationSettings.group_wait

[ "maintenance" ]AlertRuleNotificationSettings.mute_time_intervals

"grafana-default-email"AlertRuleNotificationSettings.receiver

"4h"AlertRuleNotificationSettings.repeat_interval

"A"Record.from

"grafana_alerts_ratio"Record.metric

"my-prom"Record.target_datasource_uid

"eval_group_1"ProvisionedAlertRule.ruleGroup

"Always firing"ProvisionedAlertRule.title

GET /api/v1/provisioning/alert-rules/{UID}/export

3parameters

4keywords

100%

Path Parameters1 of 1 keywords covered

UID1 / 1

#validinvalidschema

1129n/a{

2129n/a "type": "string"

3129n/a}

Query Parameters3 of 3 keywords covered

download1 / 1

12357{

22357 "type": "boolean"

32357}

format2 / 2

12157{

22157 "enum": [

311n/a "yaml",

44n/a "json",

56n/a "hcl"

62157 ],

778n/a "type": "string"

82157}

Responses1 of 3 documented received

codedescriptionhitsavg

200AlertingFileExport0never seen

403ForbiddenError0never seen

404 Not found.1163ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized130ms

Examples2 / 2 used

Query

falsedownload

"yaml"format

GET /api/v1/provisioning/contact-points

1parameter

1keyword

100%

Query Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

145n/a{

245n/a "type": "string"

345n/a}

Responses1 of 2 documented received

codedescriptionhitsavg

200ContactPoints23ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized431ms

500Internal Server Error604ms

POST /api/v1/provisioning/contact-points

2parameters

14keywords

100%

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

#validinvalidschema

1130n/a{

2130n/a "type": "string"

3130n/a}

Body13 of 13 keywords covered

application/json13 / 13

EmbeddedContactPoint

110442{

210733 "properties": {

31026 "disableResolveMessage": {

41026 "type": "boolean"

51026 },

6965 "name": {

7965 "type": "string"

8965 },

91327 "settings": {

101327 "$ref": "#/components/schemas/Json"

111327 },

121308 "type": {

131308 "enum": [

1413n/a "alertmanager",

153n/a "dingding",

163n/a "discord",

1713n/a "email",

183n/a "googlechat",

194n/a "kafka",

2025n/a "line",

212n/a "opsgenie",

221n/a "pagerduty",

232n/a "pushover",

243n/a "sensugo",

252n/a "slack",

262n/a "teams",

274n/a "telegram",

282n/a "threema",

292n/a "victorops",

3045n/a "webhook",

311n/a "wecom"

321308 ],

331335 "type": "string"

341308 },

35939 "uid": {

36961 "maxLength": 40,

37961 "minLength": 1,

38943 "pattern": "^[a-zA-Z0-9\\-\\_]+$",

39975 "type": "string"

40939 }

4110733 },

421373 "required": [

431382 "type",

441391 "settings"

451373 ],

461406 "type": "object"

4710442}

Referenced Components (1)1 of 1 keywords

Json1 of 1 keywords

11327{

21327 "type": "object"

31327}

Responses1 of 3 documented received

codedescriptionhitsavg

202EmbeddedContactPoint0never seen

400ValidationError1633ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

500Internal Server Error28ms

401Unauthorized111ms

Examples4 / 4 used

Body: application/json

falseEmbeddedContactPoint.disableResolveMessage

"webhook_1"EmbeddedContactPoint.name

"webhook"EmbeddedContactPoint.type

"my_external_reference"EmbeddedContactPoint.uid

GET /api/v1/provisioning/contact-points/export

4parameters

5keywords

100%

Query Parameters5 of 5 keywords covered

download1 / 1

#validinvalidschema

14051{

24051 "type": "boolean"

34051}

format2 / 2

16028{

26028 "enum": [

332n/a "yaml",

411n/a "json",

517n/a "hcl"

66028 ],

788n/a "type": "string"

86028}

decrypt1 / 1

14444{

24444 "type": "boolean"

34444}

name1 / 1

149n/a{

249n/a "type": "string"

349n/a}

Responses1 of 2 documented received

codedescriptionhitsavg

200AlertingFileExport443ms

403PermissionDenied0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized120ms

500Internal Server Error913ms

Examples3 / 3 used

Query

falsedownload

"yaml"format

falsedecrypt

DELETE /api/v1/provisioning/contact-points/{UID}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

UID1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses1 of 2 documented received

codedescriptionhitsavg

202 The contact point was deleted successfully.334ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized721ms

PUT /api/v1/provisioning/contact-points/{UID}

3parameters

15keywords

100%

Path Parameters1 of 1 keywords covered

UID1 / 1

#validinvalidschema

1176n/a{

2176n/a "type": "string"

3176n/a}

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

193n/a{

293n/a "type": "string"

393n/a}

Body13 of 13 keywords covered

application/json13 / 13

EmbeddedContactPoint

111437{

211729 "properties": {

3705 "disableResolveMessage": {

4705 "type": "boolean"

5705 },

6655 "name": {

7655 "type": "string"

8655 },

91405 "settings": {

101405 "$ref": "#/components/schemas/Json"

111405 },

121386 "type": {

131386 "enum": [

141n/a "alertmanager",

153n/a "dingding",

164n/a "discord",

174n/a "email",

183n/a "googlechat",

191n/a "kafka",

2035n/a "line",

218n/a "opsgenie",

223n/a "pagerduty",

232n/a "pushover",

242n/a "sensugo",

2510n/a "slack",

263n/a "teams",

274n/a "telegram",

283n/a "threema",

291n/a "victorops",

3048n/a "webhook",

313n/a "wecom"

321386 ],

331395 "type": "string"

341386 },

35648 "uid": {

36661 "maxLength": 40,

37661 "minLength": 1,

38652 "pattern": "^[a-zA-Z0-9\\-\\_]+$",

39675 "type": "string"

40648 }

4111729 },

421433 "required": [

431442 "type",

441451 "settings"

451433 ],

461465 "type": "object"

4711437}

Referenced Components (1)1 of 1 keywords

Json1 of 1 keywords

11405{

21405 "type": "object"

31405}

Responses1 of 3 documented received

codedescriptionhitsavg

202Ack0never seen

400ValidationError553ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found1134ms

401Unauthorized81ms

Examples4 / 4 used

Body: application/json

falseEmbeddedContactPoint.disableResolveMessage

"webhook_1"EmbeddedContactPoint.name

"webhook"EmbeddedContactPoint.type

"my_external_reference"EmbeddedContactPoint.uid

DELETE /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

FolderUID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Group1 / 1

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

204 The alert rule group was deleted successfully.0never seen

403ForbiddenError0never seen

404NotFound374ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized650ms

GET /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}

2parameters

2keywords

100%

Path Parameters2 of 2 keywords covered

FolderUID1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Group1 / 1

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

200AlertRuleGroup0never seen

403ForbiddenError0never seen

404 Not found.444ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized580ms

PUT /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}

4parameters

83keywords

100%

Path Parameters2 of 2 keywords covered

FolderUID1 / 1

#validinvalidschema

1492n/a{

2492n/a "type": "string"

3492n/a}

Group1 / 1

1492n/a{

2492n/a "type": "string"

3492n/a}

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

1411n/a{

2411n/a "type": "string"

3411n/a}

Body80 of 80 keywords covered

application/json80 / 80

AlertRuleGroup

1163312{

2126307 "properties": {

33895 "folderUid": {

43895 "type": "string"

53895 },

638714 "interval": {

738714 "format": "int64",

83956 "type": "integer"

938714 },

10142283 "rules": {

11142278 "items": {

12106284 "$ref": "#/components/schemas/ProvisionedAlertRule"

13142278 },

144205 "type": "array"

15142283 },

163785 "title": {

173785 "type": "string"

183785 }

19126307 },

204705 "type": "object"

21163312}

Referenced Components (7)82 of 82 keywords

AlertQuery8 of 8 keywords

1315177{

2310172 "properties": {

33995 "datasourceUid": {

43995 "type": "string"

53995 },

63875 "model": {

73875 "type": "object"

83875 },

93875 "queryType": {

103875 "type": "string"

113875 },

12334136 "refId": {

13334136 "type": "string"

14334136 },

1537721 "relativeTimeRange": {

1637721 "$ref": "#/components/schemas/RelativeTimeRange"

1737721 }

18310172 },

194875 "type": "object"

20315177}

AlertRuleNotificationSettings15 of 15 keywords

127256{

227350 "properties": {

330710 "active_time_intervals": {

43075 "items": {

53075 "type": "string"

63075 },

73125 "type": "array"

830710 },

930710 "group_by": {

103075 "items": {

119185 "type": "string"

123075 },

133125 "type": "array"

1430710 },

153115 "group_interval": {

163115 "type": "string"

173115 },

183105 "group_wait": {

193105 "type": "string"

203105 },

2130410 "mute_time_intervals": {

223045 "items": {

233045 "type": "string"

243045 },

253095 "type": "array"

2630410 },

273175 "receiver": {

283175 "type": "string"

293175 },

303085 "repeat_interval": {

313085 "type": "string"

323085 }

3327350 },

343221 "required": [

353221 "receiver"

363221 ],

373235 "type": "object"

3827256}

Duration2 of 2 keywords

167716{

267716 "format": "int64",

368112 "type": "integer"

467716}

Provenance1 of 1 keywords

13225{

23225 "type": "string"

33225}

ProvisionedAlertRule43 of 43 keywords

1106284{

2115270 "properties": {

333010 "annotations": {

43275 "additionalProperties": {

53495 "type": "string"

63275 },

73355 "type": "object"

833010 },

93795 "condition": {

103795 "type": "string"

113795 },

1230282 "data": {

1330277 "items": {

14315177 "$ref": "#/components/schemas/AlertQuery"

1530277 },

163795 "type": "array"

1730282 },

183786 "execErrState": {

193786 "enum": [

20358n/a "OK",

2113n/a "Alerting",

227n/a "Error"

233786 ],

243795 "type": "string"

253786 },

263795 "folderUID": {

273795 "type": "string"

283795 },

293786 "for": {

303781 "format": "duration",

313795 "type": "string"

323786 },

333328 "id": {

343328 "format": "int64",

353346 "type": "integer"

363328 },

373295 "isPaused": {

383295 "type": "boolean"

393295 },

403326 "keep_firing_for": {

413321 "format": "duration",

423335 "type": "string"

433326 },

4432010 "labels": {

453205 "additionalProperties": {

463265 "type": "string"

473205 },

483255 "type": "object"

4932010 },

503238 "missingSeriesEvalsToResolve": {

513238 "format": "int64",

523256 "type": "integer"

533238 },

543786 "noDataState": {

553786 "enum": [

56343n/a "Alerting",

5713n/a "NoData",

5822n/a "OK"

593786 ],

603795 "type": "string"

613786 },

6227256 "notification_settings": {

6327256 "$ref": "#/components/schemas/AlertRuleNotificationSettings"

6427256 },

653768 "orgID": {

663768 "format": "int64",

673786 "type": "integer"

683768 },

693225 "provenance": {

703225 "$ref": "#/components/schemas/Provenance"

713225 },

7230522 "record": {

7330522 "$ref": "#/components/schemas/Record"

7430522 },

753777 "ruleGroup": {

763781 "maxLength": 190,

773781 "minLength": 1,

783795 "type": "string"

793777 },

803777 "title": {

813781 "maxLength": 190,

823781 "minLength": 1,

833795 "type": "string"

843777 },

853248 "uid": {

863261 "maxLength": 40,

873261 "minLength": 1,

883252 "pattern": "^[a-zA-Z0-9-_]+$",

893275 "type": "string"

903248 }

91115270 },

923769 "required": [

933841 "orgID",

943841 "folderUID",

953841 "ruleGroup",

963841 "title",

973841 "condition",

983841 "data",

993841 "noDataState",

1003841 "execErrState",

1013841 "for"

1023769 ],

1033855 "type": "object"

104106284}

Record8 of 8 keywords

130522{

230715 "properties": {

33165 "from": {

43165 "type": "string"

53165 },

63165 "metric": {

73165 "type": "string"

83165 },

93155 "target_datasource_uid": {

103155 "type": "string"

113155 }

1230715 },

133202 "required": [

143211 "metric",

153211 "from"

163202 ],

173225 "type": "object"

1830522}

RelativeTimeRange5 of 5 keywords

137721{

234016 "properties": {

33378 "from": {

43378 "$ref": "#/components/schemas/Duration"

53378 },

63408 "to": {

73408 "$ref": "#/components/schemas/Duration"

83408 }

934016 },

103935 "type": "object"

1137721}

Responses1 of 3 documented received

codedescriptionhitsavg

200AlertRuleGroup0never seen

400ValidationError4823ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized101ms

Examples20 / 20 used

Body: application/json

{ "runbook_url": "https://supercoolrunbook.com/page/13" }ProvisionedAlertRule.annotations

"A"ProvisionedAlertRule.condition

[ { "datasourceUid": "__expr__", "model": { "conditions": [ { "evaluator": { "params": [ 0, 0 ], "type": "gt" }, "operator": { "type": "and" }, "query": { "params": [] }, "reducer": { "params": [], "type": "avg" }, "type": "query" } ], "datasource": { "type": "__expr__", "uid": "__expr__" }, "expression": "1 == 1", "hide": false, "intervalMs": 1000, "maxDataPoints": 43200, "refId": "A", "type": "math" }, "queryType": "", "refId": "A", "relativeTimeRange": { "from": 0, "to": 0 } } ]ProvisionedAlertRule.data

"project_x"ProvisionedAlertRule.folderUID

falseProvisionedAlertRule.isPaused

{ "team": "sre-team-1" }ProvisionedAlertRule.labels

2ProvisionedAlertRule.missingSeriesEvalsToResolve

[ "maintenance" ]AlertRuleNotificationSettings.active_time_intervals

[ "alertname", "grafana_folder" ]AlertRuleNotificationSettings.group_by

[ "alertname", "grafana_folder", "cluster" ]AlertRuleNotificationSettings.group_by

"5m"AlertRuleNotificationSettings.group_interval

"30s"AlertRuleNotificationSettings.group_wait

[ "maintenance" ]AlertRuleNotificationSettings.mute_time_intervals

"grafana-default-email"AlertRuleNotificationSettings.receiver

"4h"AlertRuleNotificationSettings.repeat_interval

"A"Record.from

"grafana_alerts_ratio"Record.metric

"my-prom"Record.target_datasource_uid

"eval_group_1"ProvisionedAlertRule.ruleGroup

"Always firing"ProvisionedAlertRule.title

GET /api/v1/provisioning/folder/{FolderUID}/rule-groups/{Group}/export

4parameters

5keywords

100%

Path Parameters2 of 2 keywords covered

FolderUID1 / 1

#validinvalidschema

1129n/a{

2129n/a "type": "string"

3129n/a}

Group1 / 1

1129n/a{

2129n/a "type": "string"

3129n/a}

Query Parameters3 of 3 keywords covered

download1 / 1

13451{

23451 "type": "boolean"

33451}

format2 / 2

15029{

25029 "enum": [

316n/a "yaml",

413n/a "json",

521n/a "hcl"

65029 ],

779n/a "type": "string"

85029}

Responses1 of 3 documented received

codedescriptionhitsavg

200AlertingFileExport0never seen

403ForbiddenError0never seen

404 Not found.1184ms

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized110ms

Examples2 / 2 used

Query

falsedownload

"yaml"format

GET /api/v1/provisioning/mute-timings

0parameters

0keywords

—

Responses1 of 2 documented received

codedescriptionhitsavg

200MuteTimings23ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized690ms

500Internal Server Error343ms

POST /api/v1/provisioning/mute-timings

2parameters

11keywords

100%

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

#validinvalidschema

1118n/a{

2118n/a "type": "string"

3118n/a}

Body10 of 10 keywords covered

application/json10 / 10

MuteTimeInterval

110351{

27144 "properties": {

31058 "name": {

41058 "type": "string"

51058 },

64238 "time_intervals": {

74233 "items": {

82857 "$ref": "#/components/schemas/TimeInterval"

94233 },

10755 "type": "array"

114238 }

127144 },

131477 "type": "object"

1410351}

Referenced Components (1)6 of 6 keywords

TimeInterval6 of 6 keywords

18572{

23836 "properties": {

36111 "name": {

46111 "type": "string"

56111 },

64025 "time_intervals": {

74015 "items": {

85715 "$ref": "#/components/schemas/TimeInterval"

94015 },

105510 "type": "array"

114025 }

123836 },

1312136 "type": "object"

148572}

Responses2 of 3 documented received

codedescriptionhitsavg

201MuteTimeInterval327ms

400ValidationError1093ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized81ms

500Internal Server Error443ms

GET /api/v1/provisioning/mute-timings/export

2parameters

3keywords

100%

Query Parameters3 of 3 keywords covered

download1 / 1

#validinvalidschema

14053{

24053 "type": "boolean"

34053}

format2 / 2

13074{

23074 "enum": [

314n/a "yaml",

48n/a "json",

58n/a "hcl"

63074 ],

7104n/a "type": "string"

83074}

Responses1 of 2 documented received

codedescriptionhitsavg

200AlertingFileExport293ms

403PermissionDenied0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized180ms

500Internal Server Error854ms

Examples2 / 2 used

Query

falsedownload

"yaml"format

DELETE /api/v1/provisioning/mute-timings/{name}

3parameters

3keywords

100%

Path Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

17n/a{

27n/a "type": "string"

37n/a}

Query Parameters1 of 1 keywords covered

version1 / 1

17n/a{

27n/a "type": "string"

37n/a}

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

14n/a{

24n/a "type": "string"

34n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

204 The mute timing was deleted successfully.43ms

403ForbiddenError0never seen

409PublicError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized31ms

GET /api/v1/provisioning/mute-timings/{name}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

200MuteTimeInterval0never seen

403ForbiddenError0never seen

404 Not found.23ms

PUT /api/v1/provisioning/mute-timings/{name}

3parameters

12keywords

100%

Path Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

1161n/a{

2161n/a "type": "string"

3161n/a}

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

172n/a{

272n/a "type": "string"

372n/a}

Body10 of 10 keywords covered

application/json10 / 10

MuteTimeInterval

18852{

26647 "properties": {

39412 "name": {

49412 "type": "string"

59412 },

66942 "time_intervals": {

76937 "items": {

812656 "$ref": "#/components/schemas/TimeInterval"

96937 },

101065 "type": "array"

116942 }

126647 },

131355 "type": "object"

148852}

Referenced Components (1)6 of 6 keywords

TimeInterval6 of 6 keywords

134671{

219961 "properties": {

322236 "name": {

422236 "type": "string"

522236 },

619351 "time_intervals": {

719315 "items": {

822015 "$ref": "#/components/schemas/TimeInterval"

919315 },

1020836 "type": "array"

1119351 }

1219961 },

1340710 "type": "object"

1434671}

Responses1 of 4 documented received

codedescriptionhitsavg

202MuteTimeInterval0never seen

400ValidationError1153ms

403ForbiddenError0never seen

409PublicError0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found334ms

401Unauthorized131ms

GET /api/v1/provisioning/mute-timings/{name}/export

3parameters

4keywords

100%

Path Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

129n/a{

229n/a "type": "string"

329n/a}

Query Parameters3 of 3 keywords covered

download1 / 1

11210{

21210 "type": "boolean"

31210}

format2 / 2

11112{

21112 "enum": [

39n/a "yaml",

41n/a "json",

51n/a "hcl"

61112 ],

723n/a "type": "string"

81112}

Responses0 of 2 documented received

codedescriptionhitsavg

200AlertingFileExport0never seen

403PermissionDenied0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found293ms

Examples2 / 2 used

Query

falsedownload

"yaml"format

DELETE /api/v1/provisioning/policies

0parameters

0keywords

—

Responses1 of 2 documented received

codedescriptionhitsavg

202Ack213ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized740ms

500Internal Server Error293ms

GET /api/v1/provisioning/policies

0parameters

0keywords

—

Responses1 of 2 documented received

codedescriptionhitsavg

200Route23ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized710ms

500Internal Server Error324ms

PUT /api/v1/provisioning/policies

2parameters

38keywords

100%

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

#validinvalidschema

1385n/a{

2385n/a "type": "string"

3385n/a}

Body37 of 37 keywords covered

application/json37 / 37

Route

1179400{

2167390 "properties": {

349720 "active_time_intervals": {

449710 "items": {

57110 "type": "string"

649710 },

750710 "type": "array"

849720 },

950210 "continue": {

1050210 "type": "boolean"

1150210 },

1249520 "group_by": {

1349510 "items": {

149010 "type": "string"

1549510 },

1650510 "type": "array"

1749520 },

1850110 "group_interval": {

1950110 "type": "string"

2050110 },

2150410 "group_wait": {

2250410 "type": "string"

2350410 },

2448321 "match": {

251211 "additionalProperties": {

262916 "type": "string"

271211 },

2849410 "type": "object"

2948321 },

3049020 "match_re": {

3149020 "$ref": "#/components/schemas/MatchRegexps"

3249020 },

3344856 "matchers": {

3444856 "$ref": "#/components/schemas/Matchers"

3544856 },

3649020 "mute_time_intervals": {

3749010 "items": {

389310 "type": "string"

3949010 },

4050010 "type": "array"

4149020 },

4247230 "object_matchers": {

4347230 "$ref": "#/components/schemas/ObjectMatchers"

4447230 },

4548011 "provenance": {

4648011 "$ref": "#/components/schemas/Provenance"

4748011 },

4848210 "receiver": {

4948210 "type": "string"

5048210 },

5147310 "repeat_interval": {

5247310 "type": "string"

5347310 },

54346144 "routes": {

55346133 "items": {

5649133 "$ref": "#/components/schemas/Route"

57346133 },

5847911 "type": "array"

59346144 }

60167390 },

6156910 "type": "object"

62179400}

Referenced Components (7)17 of 17 keywords

MatchRegexps2 of 2 keywords

149020{

2910 "additionalProperties": {

32810 "type": "string"

4910 },

550010 "type": "object"

649020}

MatchType2 of 2 keywords

14416{

24416 "format": "int64",

34812 "type": "integer"

44416}

Matcher6 of 6 keywords

15046{

23736 "properties": {

35510 "Name": {

45510 "type": "string"

55510 },

64416 "Type": {

74416 "$ref": "#/components/schemas/MatchType"

84416 },

95110 "Value": {

105110 "type": "string"

115110 }

123736 },

138610 "type": "object"

145046}

Matchers2 of 2 keywords

144856{

244846 "items": {

35046 "$ref": "#/components/schemas/Matcher"

444846 },

549410 "type": "array"

644856}

ObjectMatcher2 of 2 keywords

15020{

25010 "items": {

317710 "type": "string"

45010 },

56010 "type": "array"

65020}

ObjectMatchers2 of 2 keywords

147230{

247220 "items": {

35020 "$ref": "#/components/schemas/ObjectMatcher"

447220 },

549210 "type": "array"

647230}

Provenance1 of 1 keywords

148011{

248011 "type": "string"

348011}

Responses1 of 3 documented received

codedescriptionhitsavg

202Ack0never seen

400ValidationError4613ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized11ms

GET /api/v1/provisioning/policies/export

0parameters

0keywords

—

Responses1 of 3 documented received

codedescriptionhitsavg

200AlertingFileExport23ms

403ForbiddenError0never seen

404NotFound0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized740ms

500Internal Server Error293ms

GET /api/v1/provisioning/templates

0parameters

0keywords

—

Responses1 of 2 documented received

codedescriptionhitsavg

200NotificationTemplates24ms

403ForbiddenError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized690ms

500Internal Server Error343ms

DELETE /api/v1/provisioning/templates/{name}

2parameters

2keywords

100%

Path Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

15n/a{

25n/a "type": "string"

35n/a}

Query Parameters1 of 1 keywords covered

version1 / 1

15n/a{

25n/a "type": "string"

35n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

204 The template was deleted successfully.23ms

403ForbiddenError0never seen

409PublicError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized31ms

GET /api/v1/provisioning/templates/{name}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 3 documented received

codedescriptionhitsavg

200NotificationTemplate0never seen

403ForbiddenError0never seen

404PublicError24ms

PUT /api/v1/provisioning/templates/{name}

3parameters

6keywords

100%

Path Parameters1 of 1 keywords covered

name1 / 1

#validinvalidschema

1126n/a{

2126n/a "type": "string"

3126n/a}

Headers1 of 1 keywords covered

X-Disable-Provenance1 / 1

164n/a{

264n/a "type": "string"

364n/a}

Body4 of 4 keywords covered

application/json4 / 4

NotificationTemplateContent

16738{

23627 "properties": {

33910 "template": {

43910 "type": "string"

53910 },

61720 "version": {

71720 "type": "string"

81720 }

93627 },

109411 "type": "object"

116738}

Responses2 of 4 documented received

codedescriptionhitsavg

202NotificationTemplate2223ms

400PublicError944ms

403ForbiddenError0never seen

409PublicError0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized101ms

query_history 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/query-history

8parameters

14keywords

100%

Query Parameters14 of 14 keywords covered

datasourceUid2 / 2

#validinvalidschema

1101n/a{

2101n/a "items": {

3254n/a "type": "string"

4101n/a },

5101n/a "type": "array"

6101n/a}

searchString1 / 1

1107n/a{

2107n/a "type": "string"

3107n/a}

onlyStarred1 / 1

17850{

27850 "type": "boolean"

37850}

sort2 / 2

110216{

210216 "enum": [

378n/a "time-desc",

424n/a "time-asc"

510216 ],

6118n/a "type": "string"

710216}

page2 / 2

18818{

28818 "format": "int64",

39016 "type": "integer"

48818}

limit2 / 2

18919{

28919 "format": "int64",

39117 "type": "integer"

48919}

from2 / 2

110420{

210420 "format": "int64",

310618 "type": "integer"

410420}

to2 / 2

18436{

28436 "format": "int64",

38733 "type": "integer"

48436}

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)2064ms

401UnauthorizedError is returned when the request is not authenticated.161ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples1 / 1 used

Query

"time-desc"sort

POST /api/query-history

1parameter

6keywords

100%

Body6 of 6 keywords covered

application/json6 / 6

CreateQueryInQueryHistoryCommand

#validinvalidschema

18829{

29017 "properties": {

32012 "datasourceUid": {

42012 "type": "string"

52012 },

69312 "queries": {

79312 "$ref": "#/components/schemas/Json"

89312 }

99017 },

101056 "required": [

111056 "queries"

121056 ],

131116 "type": "object"

148829}

Referenced Components (1)1 of 1 keywords

Json1 of 1 keywords

19312{

29312 "type": "object"

39312}

Responses3 of 4 documented received

codedescriptionhitsavg

200(empty)9222ms

400BadRequestError is returned when the request is invalid and it cannot be processed.243ms

401UnauthorizedError is returned when the request is not authenticated.91ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples1 / 1 used

Body: application/json

"PE1C5CBDA0504A6A3"CreateQueryInQueryHistoryCommand.datasourceUid

DELETE /api/query-history/star/{query_history_uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

query_history_uid1 / 1

#validinvalidschema

1103n/a{

2103n/a "type": "string"

3103n/a}

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.650ms

500InternalServerError is a general error indicating something went wrong internally.163ms

Undocumented - not in spec

codedescriptionhitsavg

404Not Found223ms

POST /api/query-history/star/{query_history_uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

query_history_uid1 / 1

#validinvalidschema

1103n/a{

2103n/a "type": "string"

3103n/a}

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.630ms

500InternalServerError is a general error indicating something went wrong internally.163ms

Undocumented - not in spec

codedescriptionhitsavg

404Not Found243ms

DELETE /api/query-history/{query_history_uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

query_history_uid1 / 1

#validinvalidschema

1103n/a{

2103n/a "type": "string"

3103n/a}

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.760ms

500InternalServerError is a general error indicating something went wrong internally.83ms

Undocumented - not in spec

codedescriptionhitsavg

404Not Found193ms

PATCH /api/query-history/{query_history_uid}

2parameters

4keywords

100%

Path Parameters1 of 1 keywords covered

query_history_uid1 / 1

#validinvalidschema

1115n/a{

2115n/a "type": "string"

3115n/a}

Body3 of 3 keywords covered

application/json3 / 3

PatchQueryCommentInQueryHistoryCommand

18221{

2636 "properties": {

3636 "comment": {

4636 "type": "string"

5636 }

6636 },

78815 "type": "object"

88221}

Responses3 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.173ms

401UnauthorizedError is returned when the request is not authenticated.111ms

500InternalServerError is a general error indicating something went wrong internally.143ms

Undocumented - not in spec

codedescriptionhitsavg

404Not Found734ms

quota 6 operations 6 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/admin/users/{user_id}/quotas

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

11059{

21059 "format": "int64",

31068 "type": "integer"

41059}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.151ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.93ms

500InternalServerError is a general error indicating something went wrong internally.904ms

PUT /api/admin/users/{user_id}/quotas/{quota_target}

3parameters

8keywords

100%

Path Parameters3 of 3 keywords covered

quota_target1 / 1

#validinvalidschema

1140n/a{

2140n/a "type": "string"

3140n/a}

user_id2 / 2

112911{

212911 "format": "int64",

313010 "type": "integer"

412911}

Body5 of 5 keywords covered

application/json5 / 5

UpdateQuotaCmd

110423{

23517 "properties": {

33912 "limit": {

43912 "format": "int64",

5447 "type": "integer"

63912 },

7398 "target": {

8398 "type": "string"

9398 }

103517 },

111216 "type": "object"

1210423}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.81ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.113ms

500InternalServerError is a general error indicating something went wrong internally.904ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request313ms

GET /api/org/quotas

0parameters

0keywords

—

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.691ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.344ms

GET /api/orgs/{org_id}/quotas

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

org_id2 / 2

#validinvalidschema

110211{

210211 "format": "int64",

310310 "type": "integer"

410211}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.180ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.113ms

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.844ms

PUT /api/orgs/{org_id}/quotas/{quota_target}

3parameters

8keywords

100%

Path Parameters3 of 3 keywords covered

quota_target1 / 1

#validinvalidschema

1140n/a{

2140n/a "type": "string"

3140n/a}

org_id2 / 2

112911{

212911 "format": "int64",

313010 "type": "integer"

412911}

Body5 of 5 keywords covered

application/json5 / 5

UpdateQuotaCmd

110125{

24015 "properties": {

34110 "limit": {

44110 "format": "int64",

5456 "type": "integer"

64110 },

7445 "target": {

8445 "type": "string"

9445 }

104015 },

1111610 "type": "object"

1210125}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.81ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.113ms

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.874ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request344ms

GET /api/user/quotas

0parameters

0keywords

—

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.761ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request264ms

recording_rules 8 operations 8 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/recording-rules

0parameters

0keywords

—

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.760ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.263ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/recording-rules

1parameter

17keywords

100%

Body17 of 17 keywords covered

application/json17 / 17

RecordingRuleJSON

#validinvalidschema

17885{

26378 "properties": {

31086 "active": {

41086 "type": "boolean"

51086 },

61096 "count": {

71096 "type": "boolean"

81096 },

91066 "description": {

101066 "type": "string"

111066 },

121095 "dest_data_source_uid": {

131095 "type": "string"

141095 },

151095 "id": {

161095 "type": "string"

171095 },

1810111 "interval": {

1910111 "format": "int64",

201066 "type": "integer"

2110111 },

221065 "name": {

231065 "type": "string"

241065 },

251045 "prom_name": {

261045 "type": "string"

271045 },

2810311 "queries": {

291036 "items": {

3060n/a "additionalProperties": {},

317110 "type": "object"

321036 },

331095 "type": "array"

3410311 },

359615 "range": {

369615 "format": "int64",

371056 "type": "integer"

389615 },

39986 "target_ref_id": {

40986 "type": "string"

41986 }

426378 },

431567 "type": "object"

447885}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.21ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.2123ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/recording-rules

1parameter

17keywords

100%

Body17 of 17 keywords covered

application/json17 / 17

RecordingRuleJSON

#validinvalidschema

18380{

27675 "properties": {

31135 "active": {

41135 "type": "boolean"

51135 },

61115 "count": {

71115 "type": "boolean"

81115 },

91065 "description": {

101065 "type": "string"

111065 },

121115 "dest_data_source_uid": {

131115 "type": "string"

141115 },

151135 "id": {

161135 "type": "string"

171135 },

1810811 "interval": {

1910811 "format": "int64",

201118 "type": "integer"

2110811 },

221016 "name": {

231016 "type": "string"

241016 },

2511110 "prom_name": {

2611110 "type": "string"

2711110 },

289615 "queries": {

299610 "items": {

3051n/a "additionalProperties": {},

316140 "type": "object"

329610 },

331065 "type": "array"

349615 },

35979 "range": {

36979 "format": "int64",

371006 "type": "integer"

38979 },

399912 "target_ref_id": {

409912 "type": "string"

419912 }

427675 },

431585 "type": "object"

448380}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.31ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.2113ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/recording-rules/test

1parameter

17keywords

100%

Body17 of 17 keywords covered

application/json17 / 17

RecordingRuleJSON

#validinvalidschema

18180{

27775 "properties": {

310912 "active": {

410912 "type": "boolean"

510912 },

61167 "count": {

71167 "type": "boolean"

81167 },

91115 "description": {

101115 "type": "string"

111115 },

121145 "dest_data_source_uid": {

131145 "type": "string"

141145 },

151105 "id": {

161105 "type": "string"

171105 },

181068 "interval": {

191068 "format": "int64",

201086 "type": "integer"

211068 },

2211212 "name": {

2311212 "type": "string"

2411212 },

251146 "prom_name": {

261146 "type": "string"

271146 },

289911 "queries": {

29996 "items": {

3056n/a "additionalProperties": {},

317810 "type": "object"

32996 },

331055 "type": "array"

349911 },

351008 "range": {

361008 "format": "int64",

371026 "type": "integer"

381008 },

391055 "target_ref_id": {

401055 "type": "string"

411055 }

427775 },

431565 "type": "object"

448180}

Responses2 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.21ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.2123ms

422UnprocessableEntityError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/recording-rules/writer

0parameters

0keywords

—

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.660ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.363ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/recording-rules/writer

0parameters

0keywords

—

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.560ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.463ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/recording-rules/writer

1parameter

5keywords

100%

Body5 of 5 keywords covered

application/json5 / 5

PrometheusRemoteWriteTargetJSON

#validinvalidschema

13932{

22527 "properties": {

32416 "data_source_uid": {

42416 "type": "string"

52416 },

6278 "id": {

7278 "type": "string"

8278 },

93217 "remote_write_path": {

103217 "type": "string"

113217 }

122527 },

13665 "type": "object"

143932}

Responses2 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.20ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1273ms

422UnprocessableEntityError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/recording-rules/{recordingRuleID}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

recordingRuleID2 / 2

#validinvalidschema

19319{

29319 "format": "int64",

39418 "type": "integer"

49319}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.110ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1013ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

reports 13 operations 13 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/reports

0parameters

0keywords

—

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.690ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found333ms

POST /api/reports

1parameter

62keywords

100%

Body62 of 62 keywords covered

application/json62 / 62

CreateOrUpdateReport

#validinvalidschema

1140231{

2132226 "properties": {

325953 "dashboards": {

425948 "items": {

52548 "$ref": "#/components/schemas/ReportDashboard"

625948 },

73075 "type": "array"

825953 },

93045 "enableCsv": {

103045 "type": "boolean"

113045 },

123075 "enableDashboardUrl": {

133075 "type": "boolean"

143075 },

1530610 "formats": {

163065 "items": {

17285 "$ref": "#/components/schemas/Type"

183065 },

193115 "type": "array"

2030610 },

213105 "message": {

223105 "type": "string"

233105 },

243095 "name": {

253095 "type": "string"

263095 },

2726745 "options": {

2826745 "$ref": "#/components/schemas/ReportOptions"

2926745 },

303125 "recipients": {

313125 "type": "string"

323125 },

333125 "replyTo": {

343125 "type": "string"

353125 },

363058 "scaleFactor": {

373058 "format": "int64",

383076 "type": "integer"

393058 },

4026350 "schedule": {

4126350 "$ref": "#/components/schemas/ReportSchedule"

4226350 },

433015 "state": {

443015 "$ref": "#/components/schemas/State"

453015 },

463055 "subject": {

473055 "type": "string"

483055 },

4928320 "urls": {

5028315 "items": {

512115 "$ref": "#/components/schemas/ReportURLItem"

5228315 },

532985 "type": "array"

5428320 }

55132226 },

563665 "type": "object"

57140231}

Referenced Components (8)48 of 48 keywords

ReportDashboard6 of 6 keywords

12548{

22143 "properties": {

33823 "dashboard": {

43823 "$ref": "#/components/schemas/ReportDashboardID"

53823 },

6555 "reportVariables": {

7555 "type": "object"

8555 },

94615 "timeRange": {

104615 "$ref": "#/components/schemas/ReportTimeRange"

114615 }

122143 },

13685 "type": "object"

142548}

ReportDashboardID7 of 7 keywords

13823{

23518 "properties": {

3438 "id": {

4438 "format": "int64",

5456 "type": "integer"

6438 },

7455 "name": {

8455 "type": "string"

9455 },

10445 "uid": {

11445 "type": "string"

12445 }

133518 },

14565 "type": "object"

153823}

ReportOptions9 of 9 keywords

126745{

225940 "properties": {

32875 "csvEncoding": {

42875 "type": "string"

52875 },

62875 "layout": {

72875 "type": "string"

82875 },

92865 "orientation": {

102865 "type": "string"

112865 },

122865 "pdfCombineOneFile": {

132865 "type": "boolean"

142865 },

152845 "pdfShowTemplateVariables": {

162845 "type": "boolean"

172845 },

1827415 "timeRange": {

1927415 "$ref": "#/components/schemas/ReportTimeRange"

2027415 }

2125940 },

223075 "type": "object"

2326745}

ReportSchedule14 of 14 keywords

126350{

226045 "properties": {

32935 "dayOfMonth": {

42935 "type": "string"

52935 },

62916 "endDate": {

72911 "format": "date-time",

82925 "type": "string"

92916 },

102915 "frequency": {

112915 "type": "string"

122915 },

132818 "intervalAmount": {

142818 "format": "int64",

152836 "type": "integer"

162818 },

172895 "intervalFrequency": {

182895 "type": "string"

192895 },

202816 "startDate": {

212811 "format": "date-time",

222825 "type": "string"

232816 },

242815 "timeZone": {

252815 "type": "string"

262815 },

272805 "workdaysOnly": {

282805 "type": "boolean"

292805 }

3026045 },

313085 "type": "object"

3226350}

ReportTimeRange5 of 5 keywords

132030{

231620 "properties": {

332210 "from": {

432210 "type": "string"

532210 },

632410 "to": {

732410 "type": "string"

832410 }

931620 },

1034010 "type": "object"

1132030}

ReportURLItem5 of 5 keywords

12115{

21510 "properties": {

3195 "title": {

4195 "type": "string"

5195 },

6185 "url": {

7185 "type": "string"

8185 }

91510 },

10315 "type": "object"

112115}

State1 of 1 keywords

13015{

23015 "type": "string"

33015}

Type1 of 1 keywords

1285{

2285 "type": "string"

3285}

Responses2 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.81ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.4193ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/reports/dashboards/{uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

uid1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.640ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found383ms

POST /api/reports/email

1parameter

6keywords

100%

Body6 of 6 keywords covered

application/json6 / 6

ReportEmail

#validinvalidschema

13392{

21374 "properties": {

35126 "emails": {

45126 "type": "string"

55126 },

6072 "id": {

7171 "format": "int64",

8666 "type": "string"

9072 },

106012 "useEmailsFromReport": {

116012 "type": "boolean"

126012 }

131374 },

1410718 "type": "object"

153392}

Responses2 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.51ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1253ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/reports/images/:image

0parameters

0keywords

—

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.670ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.353ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/reports/render/csvs

2parameters

2keywords

100%

Query Parameters2 of 2 keywords covered

dashboards1 / 1

#validinvalidschema

135n/a{

235n/a "type": "string"

335n/a}

title1 / 1

136n/a{

236n/a "type": "string"

336n/a}

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

204(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.470ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found573ms

GET /api/reports/render/pdfs

6parameters

6keywords

100%

Query Parameters6 of 6 keywords covered

dashboards1 / 1

#validinvalidschema

147n/a{

247n/a "type": "string"

347n/a}

orientation1 / 1

111n/a{

211n/a "type": "string"

311n/a}

layout1 / 1

126n/a{

226n/a "type": "string"

326n/a}

title1 / 1

112n/a{

212n/a "type": "string"

312n/a}

scaleFactor1 / 1

113n/a{

213n/a "type": "string"

313n/a}

includeTables1 / 1

129n/a{

229n/a "type": "string"

329n/a}

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.340ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found783ms

GET /api/reports/settings

0parameters

0keywords

—

Responses1 of 4 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.660ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found363ms

POST /api/reports/settings

1parameter

32keywords

100%

Body32 of 32 keywords covered

application/json32 / 32

ReportSettings

#validinvalidschema

1100130{

296125 "properties": {

317430 "branding": {

417430 "$ref": "#/components/schemas/ReportBrandingOptions"

517430 },

61945 "embeddedImageTheme": {

71945 "type": "string"

81945 },

91886 "footerFontFamily": {

101886 "type": "string"

111886 },

1216140 "footerItems": {

1316135 "items": {

1415435 "$ref": "#/components/schemas/FooterItem"

1516135 },

161965 "type": "array"

1716140 },

181878 "id": {

191878 "format": "int64",

201896 "type": "integer"

211878 },

221859 "orgId": {

231859 "format": "int64",

241877 "type": "integer"

251859 },

261955 "pdfDashboardTitleEnabled": {

271955 "type": "boolean"

281955 },

291876 "pdfHeaderEnabled": {

301876 "type": "boolean"

311876 },

321865 "pdfTheme": {

331865 "type": "string"

341865 },

351825 "pdfTimeRangeEnabled": {

361825 "type": "boolean"

371825 },

381858 "userId": {

391858 "format": "int64",

401876 "type": "integer"

411858 }

4296125 },

432255 "type": "object"

44100130}

Referenced Components (2)17 of 17 keywords

FooterItem9 of 9 keywords

115435{

213030 "properties": {

31025 "color": {

41025 "type": "string"

51025 },

61075 "fontSize": {

71075 "type": "string"

81075 },

91045 "fontStyle": {

101045 "type": "string"

111045 },

121135 "fontWeight": {

131135 "type": "string"

141135 },

151055 "type": {

161055 "type": "string"

171055 },

18975 "value": {

19975 "type": "string"

20975 }

2113030 },

221845 "type": "object"

2315435}

ReportBrandingOptions8 of 8 keywords

117430{

216725 "properties": {

31595 "emailFooterLink": {

41595 "type": "string"

51595 },

61675 "emailFooterMode": {

71675 "type": "string"

81675 },

91685 "emailFooterText": {

101685 "type": "string"

111685 },

121665 "emailLogoUrl": {

131665 "type": "string"

141665 },

151615 "reportLogoUrl": {

161615 "type": "string"

171615 }

1816725 },

191995 "type": "object"

2017430}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.11ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found2893ms

POST /api/reports/test-email

1parameter

62keywords

100%

Body62 of 62 keywords covered

application/json62 / 62

CreateOrUpdateReport

#validinvalidschema

1131237{

2125232 "properties": {

326559 "dashboards": {

426554 "items": {

510560 "$ref": "#/components/schemas/ReportDashboard"

626554 },

73195 "type": "array"

826559 },

93285 "enableCsv": {

103285 "type": "boolean"

113285 },

123165 "enableDashboardUrl": {

133165 "type": "boolean"

143165 },

1531510 "formats": {

163155 "items": {

171085 "$ref": "#/components/schemas/Type"

183155 },

193205 "type": "array"

2031510 },

213205 "message": {

223205 "type": "string"

233205 },

243215 "name": {

253215 "type": "string"

263215 },

2727345 "options": {

2827345 "$ref": "#/components/schemas/ReportOptions"

2927345 },

303185 "recipients": {

313185 "type": "string"

323185 },

333105 "replyTo": {

343105 "type": "string"

353105 },

363158 "scaleFactor": {

373158 "format": "int64",

383176 "type": "integer"

393158 },

4027150 "schedule": {

4127150 "$ref": "#/components/schemas/ReportSchedule"

4227150 },

433165 "state": {

443165 "$ref": "#/components/schemas/State"

453165 },

463065 "subject": {

473065 "type": "string"

483065 },

4930520 "urls": {

5030515 "items": {

5115615 "$ref": "#/components/schemas/ReportURLItem"

5230515 },

533205 "type": "array"

5430520 }

55125232 },

563635 "type": "object"

57131237}

Referenced Components (8)48 of 48 keywords

ReportDashboard6 of 6 keywords

110560{

27855 "properties": {

38623 "dashboard": {

48623 "$ref": "#/components/schemas/ReportDashboardID"

58623 },

69617 "reportVariables": {

79617 "type": "object"

89617 },

98115 "timeRange": {

108115 "$ref": "#/components/schemas/ReportTimeRange"

118115 }

127855 },

131605 "type": "object"

1410560}

ReportDashboardID7 of 7 keywords

18623{

26618 "properties": {

3588 "id": {

4588 "format": "int64",

5606 "type": "integer"

6588 },

7605 "name": {

8605 "type": "string"

9605 },

10745 "uid": {

11745 "type": "string"

12745 }

136618 },

141045 "type": "object"

158623}

ReportOptions9 of 9 keywords

127345{

227040 "properties": {

32935 "csvEncoding": {

42935 "type": "string"

52935 },

62945 "layout": {

72945 "type": "string"

82945 },

92995 "orientation": {

102995 "type": "string"

112995 },

122915 "pdfCombineOneFile": {

132915 "type": "boolean"

142915 },

152975 "pdfShowTemplateVariables": {

162975 "type": "boolean"

172975 },

1828015 "timeRange": {

1928015 "$ref": "#/components/schemas/ReportTimeRange"

2028015 }

2127040 },

223135 "type": "object"

2327345}

ReportSchedule14 of 14 keywords

127150{

226645 "properties": {

32865 "dayOfMonth": {

42865 "type": "string"

52865 },

62856 "endDate": {

72851 "format": "date-time",

82865 "type": "string"

92856 },

102875 "frequency": {

112875 "type": "string"

122875 },

132778 "intervalAmount": {

142778 "format": "int64",

152796 "type": "integer"

162778 },

172865 "intervalFrequency": {

182865 "type": "string"

192865 },

202836 "startDate": {

212831 "format": "date-time",

222845 "type": "string"

232836 },

242865 "timeZone": {

252865 "type": "string"

262865 },

272815 "workdaysOnly": {

282815 "type": "boolean"

292815 }

3026645 },

313165 "type": "object"

3227150}

ReportTimeRange5 of 5 keywords

136130{

233920 "properties": {

334410 "from": {

434410 "type": "string"

534410 },

633610 "to": {

733610 "type": "string"

833610 }

933920 },

1038110 "type": "object"

1136130}

ReportURLItem5 of 5 keywords

115615{

29410 "properties": {

3595 "title": {

4595 "type": "string"

5595 },

6915 "url": {

7915 "type": "string"

8915 }

99410 },

101665 "type": "object"

1115615}

State1 of 1 keywords

13165{

23165 "type": "string"

33165}

Type1 of 1 keywords

11085{

21085 "type": "string"

31085}

Responses2 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.121ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.4153ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/reports/{id}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

id2 / 2

#validinvalidschema

19319{

29319 "format": "int64",

39418 "type": "integer"

49319}

Responses2 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.101ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1024ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/reports/{id}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

id2 / 2

#validinvalidschema

18824{

28824 "format": "int64",

38923 "type": "integer"

48824}

Responses2 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.80ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1043ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/reports/{id}

2parameters

64keywords

100%

Path Parameters2 of 2 keywords covered

id2 / 2

#validinvalidschema

142314{

242314 "format": "int64",

342413 "type": "integer"

442314}

Body62 of 62 keywords covered

application/json62 / 62

CreateOrUpdateReport

1156232{

2143227 "properties": {

327453 "dashboards": {

427448 "items": {

56048 "$ref": "#/components/schemas/ReportDashboard"

627448 },

73225 "type": "array"

827453 },

93235 "enableCsv": {

103235 "type": "boolean"

113235 },

123215 "enableDashboardUrl": {

133215 "type": "boolean"

143215 },

1531110 "formats": {

163115 "items": {

17105 "$ref": "#/components/schemas/Type"

183115 },

193165 "type": "array"

2031110 },

213225 "message": {

223225 "type": "string"

233225 },

243175 "name": {

253175 "type": "string"

263175 },

2727345 "options": {

2827345 "$ref": "#/components/schemas/ReportOptions"

2927345 },

303235 "recipients": {

313235 "type": "string"

323235 },

333205 "replyTo": {

343205 "type": "string"

353205 },

363128 "scaleFactor": {

373128 "format": "int64",

383146 "type": "integer"

393128 },

4027051 "schedule": {

4127051 "$ref": "#/components/schemas/ReportSchedule"

4227051 },

433205 "state": {

443205 "$ref": "#/components/schemas/State"

453205 },

463055 "subject": {

473055 "type": "string"

483055 },

4929421 "urls": {

5029416 "items": {

512818 "$ref": "#/components/schemas/ReportURLItem"

5229416 },

533105 "type": "array"

5429421 }

55143227 },

563835 "type": "object"

57156232}

Referenced Components (8)48 of 48 keywords

ReportDashboard6 of 6 keywords

16048{

24943 "properties": {

36123 "dashboard": {

46123 "$ref": "#/components/schemas/ReportDashboardID"

56123 },

6725 "reportVariables": {

7725 "type": "object"

8725 },

96915 "timeRange": {

106915 "$ref": "#/components/schemas/ReportTimeRange"

116915 }

124943 },

131035 "type": "object"

146048}

ReportDashboardID7 of 7 keywords

16123{

24918 "properties": {

3548 "id": {

4548 "format": "int64",

5566 "type": "integer"

6548 },

7585 "name": {

8585 "type": "string"

9585 },

10505 "uid": {

11505 "type": "string"

12505 }

134918 },

14795 "type": "object"

156123}

ReportOptions9 of 9 keywords

127345{

227040 "properties": {

32975 "csvEncoding": {

42975 "type": "string"

52975 },

62985 "layout": {

72985 "type": "string"

82985 },

92965 "orientation": {

102965 "type": "string"

112965 },

122965 "pdfCombineOneFile": {

132965 "type": "boolean"

142965 },

152945 "pdfShowTemplateVariables": {

162945 "type": "boolean"

172945 },

1828115 "timeRange": {

1928115 "$ref": "#/components/schemas/ReportTimeRange"

2028115 }

2127040 },

223135 "type": "object"

2327345}

ReportSchedule14 of 14 keywords

127051{

226346 "properties": {

32956 "dayOfMonth": {

42956 "type": "string"

52956 },

62947 "endDate": {

72941 "format": "date-time",

82956 "type": "string"

92947 },

102935 "frequency": {

112935 "type": "string"

122935 },

132898 "intervalAmount": {

142898 "format": "int64",

152916 "type": "integer"

162898 },

172915 "intervalFrequency": {

182915 "type": "string"

192915 },

202896 "startDate": {

212891 "format": "date-time",

222905 "type": "string"

232896 },

242905 "timeZone": {

252905 "type": "string"

262905 },

272885 "workdaysOnly": {

282885 "type": "boolean"

292885 }

3026346 },

313165 "type": "object"

3227051}

ReportTimeRange5 of 5 keywords

135030{

233420 "properties": {

333710 "from": {

433710 "type": "string"

533710 },

633910 "to": {

733910 "type": "string"

833910 }

933420 },

1037010 "type": "object"

1135030}

ReportURLItem5 of 5 keywords

12818{

21410 "properties": {

3175 "title": {

4175 "type": "string"

5175 },

6165 "url": {

7165 "type": "string"

8165 }

91410 },

10388 "type": "object"

112818}

State1 of 1 keywords

13205{

23205 "type": "string"

33205}

Type1 of 1 keywords

1105{

2105 "type": "string"

3105}

Responses2 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.11ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.4363ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

saml 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/logout/saml

0parameters

0keywords

—

Responses1 of 3 documented received

codedescriptionhitsavg

302(empty)0never seen

404NotFoundError is returned when the requested resource was not found.324ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

401Unauthorized701ms

POST /api/saml/acs

1parameter

1keyword

100%

Query Parameters1 of 1 keywords covered

RelayState1 / 1

#validinvalidschema

137n/a{

237n/a "type": "string"

337n/a}

Responses0 of 3 documented received

codedescriptionhitsavg

302(empty)0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found383ms

401Unauthorized640ms

GET /api/saml/metadata

0parameters

0keywords

—

Responses0 of 1 documented received

codedescriptionhitsavg

200(empty)0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found273ms

401Unauthorized750ms

GET /api/saml/slo

0parameters

0keywords

—

Responses0 of 4 documented received

codedescriptionhitsavg

302(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found363ms

401Unauthorized660ms

POST /api/saml/slo

2parameters

2keywords

100%

Query Parameters2 of 2 keywords covered

SAMLRequest1 / 1

#validinvalidschema

126n/a{

226n/a "type": "string"

326n/a}

SAMLResponse1 / 1

126n/a{

226n/a "type": "string"

326n/a}

Responses0 of 4 documented received

codedescriptionhitsavg

302(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found403ms

401Unauthorized640ms

search 2 operations 2 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/search

13parameters

25keywords

100%

Query Parameters25 of 25 keywords covered

query1 / 1

#validinvalidschema

1118n/a{

2118n/a "type": "string"

3118n/a}

tag2 / 2

1121n/a{

2121n/a "items": {

3206n/a "type": "string"

4121n/a },

5121n/a "type": "array"

6121n/a}

type2 / 2

110712{

210712 "enum": [

3102n/a "dash-folder",

45n/a "dash-db"

510712 ],

6119n/a "type": "string"

710712}

dashboardIds3 / 3

111753{

211753 "items": {

3164281 "format": "int64",

4166279 "type": "integer"

511753 },

6170n/a "type": "array"

711753}

dashboardUIDs2 / 2

1130n/a{

2130n/a "items": {

3180n/a "type": "string"

4130n/a },

5130n/a "type": "array"

6130n/a}

folderIds3 / 3

111514{

211514 "items": {

318516 "format": "int64",

418714 "type": "integer"

511514 },

6129n/a "type": "array"

711514}

folderUIDs2 / 2

1131n/a{

2131n/a "items": {

3198n/a "type": "string"

4131n/a },

5131n/a "type": "array"

6131n/a}

starred1 / 1

111411{

211411 "type": "boolean"

311411}

limit2 / 2

111917{

211917 "format": "int64",

312115 "type": "integer"

411917}

page2 / 2

111320{

211320 "format": "int64",

311518 "type": "integer"

411320}

permission2 / 2

111014{

211014 "enum": [

3101n/a "Edit",

49n/a "View"

511014 ],

6124n/a "type": "string"

711014}

sort2 / 2

111517{

211517 "enum": [

3104n/a "alpha-asc",

411n/a "alpha-desc"

511517 ],

6132n/a "type": "string"

711517}

deleted1 / 1

112216{

212216 "type": "boolean"

312216}

Responses4 of 4 documented received

codedescriptionhitsavg

200(empty)1524ms

401UnauthorizedError is returned when the request is not authenticated.101ms

422UnprocessableEntityError113ms

500InternalServerError is a general error indicating something went wrong internally.114ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request1123ms

Examples2 / 2 used

Query

"View"permission

"alpha-asc"sort

GET /api/search/sorting

0parameters

0keywords

—

Responses2 of 2 documented received

codedescriptionhitsavg

200(empty)253ms

401UnauthorizedError is returned when the request is not authenticated.800ms

service_accounts 8 operations 8 covered 0 partial 0 uncovered 0 not measured 100%

#

POST /api/serviceaccounts

1parameter

6keywords

100%

Body6 of 6 keywords covered

application/json6 / 6

CreateServiceAccountForm

#validinvalidschema

17843{

25633 "properties": {

35913 "isDisabled": {

45913 "type": "boolean"

55913 },

6625 "name": {

7625 "type": "string"

8625 },

95422 "role": {

105422 "enum": [

1128n/a "None",

123n/a "Viewer",

133n/a "Editor",

1420n/a "Admin"

155422 ],

16715 "type": "string"

175422 }

185633 },

1911110 "type": "object"

207843}

Responses3 of 5 documented received

codedescriptionhitsavg

201(empty)925ms

400BadRequestError is returned when the request is invalid and it cannot be processed.1193ms

401UnauthorizedError is returned when the request is not authenticated.91ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples3 / 3 used

Body: application/json

falseCreateServiceAccountForm.isDisabled

"grafana"CreateServiceAccountForm.name

"Admin"CreateServiceAccountForm.role

GET /api/serviceaccounts/search

5parameters

7keywords

100%

Query Parameters7 of 7 keywords covered

Disabled1 / 1

#validinvalidschema

16657{

26657 "type": "boolean"

36657}

expiredTokens1 / 1

18033{

28033 "type": "boolean"

38033}

query1 / 1

180n/a{

280n/a "type": "string"

380n/a}

perpage2 / 2

15757{

25757 "format": "int64",

36054 "type": "integer"

45757}

page2 / 2

18720{

28720 "format": "int64",

38918 "type": "integer"

48720}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)1604ms

401UnauthorizedError is returned when the request is not authenticated.91ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/serviceaccounts/{serviceAccountId}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

serviceAccountId2 / 2

#validinvalidschema

177{

277 "format": "int64",

386 "type": "integer"

477}

Responses1 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.143ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/serviceaccounts/{serviceAccountId}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

serviceAccountId2 / 2

#validinvalidschema

11097{

21097 "format": "int64",

31106 "type": "integer"

41097}

Responses3 of 6 documented received

codedescriptionhitsavg

200(empty)24ms

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.121ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1023ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PATCH /api/serviceaccounts/{serviceAccountId}

2parameters

10keywords

100%

Path Parameters2 of 2 keywords covered

serviceAccountId2 / 2

#validinvalidschema

11538{

21538 "format": "int64",

31547 "type": "integer"

41538}

Body8 of 8 keywords covered

application/json8 / 8

UpdateServiceAccountForm

17436{

26927 "properties": {

3577 "isDisabled": {

4577 "type": "boolean"

5577 },

6547 "name": {

7547 "type": "string"

8547 },

9527 "role": {

10527 "enum": [

1138n/a "None",

121n/a "Viewer",

136n/a "Editor",

147n/a "Admin"

15527 ],

16545 "type": "string"

17527 },

18749 "serviceAccountId": {

19749 "format": "int64",

20776 "type": "integer"

21749 }

226927 },

231019 "type": "object"

247436}

Responses4 of 6 documented received

codedescriptionhitsavg

200(empty)218ms

400BadRequestError is returned when the request is invalid and it cannot be processed.453ms

401UnauthorizedError is returned when the request is not authenticated.581ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.373ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/serviceaccounts/{serviceAccountId}/tokens

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

serviceAccountId2 / 2

#validinvalidschema

110214{

210214 "format": "int64",

310313 "type": "integer"

410214}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)833ms

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.191ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found143ms

POST /api/serviceaccounts/{serviceAccountId}/tokens

2parameters

7keywords

100%

Path Parameters2 of 2 keywords covered

serviceAccountId2 / 2

#validinvalidschema

11309{

21309 "format": "int64",

31318 "type": "integer"

41309}

Body5 of 5 keywords covered

application/json5 / 5

AddServiceAccountTokenCommand

19224{

24517 "properties": {

3439 "name": {

4439 "type": "string"

5439 },

63812 "secondsToLive": {

73812 "format": "int64",

84010 "type": "integer"

93812 }

104517 },

111097 "type": "object"

129224}

Responses3 of 7 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.283ms

401UnauthorizedError is returned when the request is not authenticated.21ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1093ms

409ConflictError0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

DELETE /api/serviceaccounts/{serviceAccountId}/tokens/{tokenId}

2parameters

4keywords

100%

Path Parameters4 of 4 keywords covered

tokenId2 / 2

#validinvalidschema

1418{

2418 "format": "int64",

3427 "type": "integer"

4418}

serviceAccountId2 / 2

1409{

2409 "format": "int64",

3418 "type": "integer"

4409}

Responses2 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.21ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.473ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

signed_in_user 13 operations 12 covered 1 partial 0 uncovered 0 not measured 98%

#

GET /api/user

0parameters

0keywords

—

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)314ms

401UnauthorizedError is returned when the request is not authenticated.741ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/user

1parameter

6keywords

83%

Body5 of 6 keywords covered

application/json5 / 6

UpdateUserCommand

#validinvalidschema

18842{

28833 "properties": {

34819 "email": {

44819 "type": "string"

54819 },

61210 "login": {

71210 "type": "string"

81210 },

94417 "name": {

104417 "type": "string"

114417 },

124610 "theme": {

134610 "type": "string"

144610 }

158833 },

161219 "type": "object"

178842}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.8023ms

401UnauthorizedError is returned when the request is not authenticated.101ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

409ConflictError54ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request444ms

GET /api/user/auth-tokens

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)294ms

401UnauthorizedError is returned when the request is not authenticated.760ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/user/orgs

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)324ms

401UnauthorizedError is returned when the request is not authenticated.731ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/user/password

1parameter

5keywords

100%

Body5 of 5 keywords covered

application/json5 / 5

ChangeUserPasswordCommand

#validinvalidschema

14867{

22553 "properties": {

32948 "newPassword": {

42948 "$ref": "#/components/schemas/Password"

52948 },

61512 "oldPassword": {

71512 "$ref": "#/components/schemas/Password"

81512 }

92553 },

1010114 "type": "object"

114867}

Referenced Components (1)1 of 1 keywords

Password1 of 1 keywords

14460{

24460 "type": "string"

34460}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.1089ms

401UnauthorizedError is returned when the request is not authenticated.151ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/user/preferences

0parameters

0keywords

—

Responses2 of 3 documented received

codedescriptionhitsavg

200(empty)315ms

401UnauthorizedError is returned when the request is not authenticated.741ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PATCH /api/user/preferences

1parameter

19keywords

100%

Body19 of 19 keywords covered

application/json19 / 19

PatchPrefsCmd

#validinvalidschema

112068{

211060 "properties": {

31368 "homeDashboardId": {

41368 "format": "int64",

51386 "type": "integer"

61368 },

71335 "homeDashboardUID": {

81335 "type": "string"

91335 },

101345 "language": {

111345 "type": "string"

121345 },

1312616 "navbar": {

1412616 "$ref": "#/components/schemas/NavbarPreference"

1512616 },

1613411 "queryHistory": {

1713411 "$ref": "#/components/schemas/QueryHistoryPreference"

1813411 },

191177 "theme": {

201177 "enum": [

2185n/a "light",

2232n/a "dark"

231177 ],

241195 "type": "string"

251177 },

261295 "timezone": {

271295 "type": "string"

281295 },

291245 "weekStart": {

301245 "type": "string"

311245 }

3211060 },

331808 "type": "object"

3412068}

Referenced Components (2)9 of 9 keywords

NavbarPreference5 of 5 keywords

112616{

28211 "properties": {

38211 "bookmarkUrls": {

4825 "items": {

5645 "type": "string"

6825 },

7876 "type": "array"

88211 }

98211 },

101375 "type": "object"

1112616}

QueryHistoryPreference4 of 4 keywords

113411{

2956 "properties": {

3956 "homeTab": {

4956 "type": "string"

5956 }

6956 },

71405 "type": "object"

813411}

Responses3 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.8122ms

400BadRequestError is returned when the request is invalid and it cannot be processed.583ms

401UnauthorizedError is returned when the request is not authenticated.51ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

422Unprocessable Entity404ms

404Not Found104ms

Examples1 / 1 used

Body: application/json

0PatchPrefsCmd.homeDashboardId

PUT /api/user/preferences

1parameter

19keywords

100%

Body19 of 19 keywords covered

application/json19 / 19

UpdatePrefsCmd

#validinvalidschema

170113{

258104 "properties": {

310612 "homeDashboardId": {

410612 "format": "int64",

51117 "type": "integer"

610612 },

710710 "homeDashboardUID": {

810710 "type": "string"

910710 },

10958 "language": {

11958 "type": "string"

12958 },

138923 "navbar": {

148923 "$ref": "#/components/schemas/NavbarPreference"

158923 },

168550 "queryHistory": {

178550 "$ref": "#/components/schemas/QueryHistoryPreference"

188550 },

19948 "theme": {

20948 "enum": [

2166n/a "light",

2217n/a "dark",

2311n/a "system"

24948 ],

25975 "type": "string"

26948 },

27897 "timezone": {

28897 "type": "string"

29897 },

309527 "weekStart": {

319527 "type": "string"

329527 }

3358104 },

341749 "type": "object"

3570113}

Referenced Components (2)9 of 9 keywords

NavbarPreference5 of 5 keywords

18923{

27615 "properties": {

37615 "bookmarkUrls": {

4767 "items": {

57115 "type": "string"

6767 },

7838 "type": "array"

87615 }

97615 },

101048 "type": "object"

118923}

QueryHistoryPreference4 of 4 keywords

18550{

27845 "properties": {

37845 "homeTab": {

47845 "type": "string"

57845 }

67845 },

71305 "type": "object"

88550}

Responses3 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.6522ms

400BadRequestError is returned when the request is invalid and it cannot be processed.1064ms

401UnauthorizedError is returned when the request is not authenticated.91ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

422Unprocessable Entity85ms

404Not Found74ms

Examples1 / 1 used

Body: application/json

0UpdatePrefsCmd.homeDashboardId

POST /api/user/revoke-auth-token

1parameter

4keywords

100%

Body4 of 4 keywords covered

application/json4 / 4

RevokeAuthTokenCmd

#validinvalidschema

14760{

2208 "properties": {

3208 "authTokenId": {

4208 "format": "int64",

5226 "type": "integer"

6208 }

7208 },

85552 "type": "object"

94760}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.713ms

401UnauthorizedError is returned when the request is not authenticated.50ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found463ms

DELETE /api/user/stars/dashboard/uid/{dashboard_uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

dashboard_uid1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.346ms

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.710ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/user/stars/dashboard/uid/{dashboard_uid}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

dashboard_uid1 / 1

#validinvalidschema

1105n/a{

2105n/a "type": "string"

3105n/a}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.3814ms

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.671ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/user/teams

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)284ms

401UnauthorizedError is returned when the request is not authenticated.771ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/user/using/{org_id}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

org_id2 / 2

#validinvalidschema

110610{

210610 "format": "int64",

31079 "type": "integer"

410610}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.6024ms

400BadRequestError is returned when the request is invalid and it cannot be processed.103ms

401UnauthorizedError is returned when the request is not authenticated.461ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

signing_keys 1 operation 1 covered 0 partial 0 uncovered 0 not measured —

#

GET /api/signing-keys/keys

0parameters

0keywords

—

Responses1 of 2 documented received

codedescriptionhitsavg

200(empty)1311ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

snapshots 1 operation 1 covered 0 partial 0 uncovered 0 not measured —

#

GET /api/snapshot/shared-options

0parameters

0keywords

—

Responses2 of 2 documented received

codedescriptionhitsavg

200(empty)403ms

401UnauthorizedError is returned when the request is not authenticated.650ms

sso_settings 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/v1/sso-settings

0parameters

0keywords

—

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)324ms

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.730ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

DELETE /api/v1/sso-settings/{key}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

key1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 6 documented received

codedescriptionhitsavg

204An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.640ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.383ms

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/v1/sso-settings/{key}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

key1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.590ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.433ms

PATCH /api/v1/sso-settings/{key}

2parameters

5keywords

100%

Path Parameters1 of 1 keywords covered

key1 / 1

#validinvalidschema

1122n/a{

2122n/a "type": "string"

3122n/a}

Body4 of 4 keywords covered

application/json4 / 4

18928{

25814 "properties": {

35814 "settings": {

453n/a "additionalProperties": {},

55814 "type": "object"

65814 }

75814 },

810314 "type": "object"

98928}

Responses2 of 5 documented received

codedescriptionhitsavg

204An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.141ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.1084ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/v1/sso-settings/{key}

2parameters

7keywords

100%

Path Parameters1 of 1 keywords covered

key1 / 1

#validinvalidschema

1136n/a{

2136n/a "type": "string"

3136n/a}

Body6 of 6 keywords covered

application/json6 / 6

111020{

29315 "properties": {

3995 "id": {

4995 "type": "string"

5995 },

6495 "provider": {

7495 "type": "string"

8495 },

9765 "settings": {

1061n/a "additionalProperties": {},

11765 "type": "object"

12765 }

139315 },

141255 "type": "object"

1511020}

Responses2 of 5 documented received

codedescriptionhitsavg

204An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.61ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.1303ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

sync_team_groups 4 operations 4 covered 0 partial 0 uncovered 0 not measured 100%

#

DELETE /api/teams/{teamId}/groups

2parameters

2keywords

100%

Path Parameters1 of 1 keywords covered

teamId1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Query Parameters1 of 1 keywords covered

groupId1 / 1

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.23ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/teams/{teamId}/groups

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

teamId1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses1 of 6 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.23ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/teams/{teamId}/groups

2parameters

4keywords

100%

Path Parameters1 of 1 keywords covered

teamId1 / 1

#validinvalidschema

1115n/a{

2115n/a "type": "string"

3115n/a}

Body3 of 3 keywords covered

application/json3 / 3

TeamGroupMapping

14364{

21714 "properties": {

31714 "groupId": {

41714 "type": "string"

51714 }

61714 },

75750 "type": "object"

84364}

Responses2 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.51ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.1103ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/teams/{teamId}/groups/search

5parameters

8keywords

100%

Path Parameters2 of 2 keywords covered

teamId2 / 2

#validinvalidschema

1487{

2487 "format": "int64",

3496 "type": "integer"

4487}

Query Parameters6 of 6 keywords covered

page2 / 2

13114{

23114 "format": "int64",

33312 "type": "integer"

43114}

perpage2 / 2

13014{

23014 "format": "int64",

33212 "type": "integer"

43014}

query1 / 1

136n/a{

236n/a "type": "string"

336n/a}

name1 / 1

138n/a{

238n/a "type": "string"

338n/a}

Responses0 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found553ms

Examples2 / 2 used

Query

1page

1000perpage

teams 12 operations 12 covered 0 partial 0 uncovered 0 not measured 100%

#

POST /api/teams

1parameter

5keywords

100%

Body5 of 5 keywords covered

application/json5 / 5

CreateTeamCommand

#validinvalidschema

19623{

29810 "properties": {

3295 "email": {

4295 "type": "string"

5295 },

61015 "name": {

71015 "type": "string"

81015 }

99810 },

101068 "required": [

111068 "name"

121068 ],

131145 "type": "object"

149623}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)1856ms

401UnauthorizedError is returned when the request is not authenticated.51ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

409ConflictError557ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request464ms

GET /api/teams/search

6parameters

8keywords

100%

Query Parameters8 of 8 keywords covered

page2 / 2

#validinvalidschema

14560{

24560 "format": "int64",

34956 "type": "integer"

44560}

perpage2 / 2

17517{

27517 "format": "int64",

37715 "type": "integer"

47517}

name1 / 1

189n/a{

289n/a "type": "string"

389n/a}

query1 / 1

186n/a{

286n/a "type": "string"

386n/a}

accesscontrol1 / 1

18513{

28513 "type": "boolean"

38513}

sort1 / 1

181n/a{

281n/a "type": "string"

381n/a}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)1144ms

401UnauthorizedError is returned when the request is not authenticated.121ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request364ms

Examples3 / 3 used

Query

1page

1000perpage

falseaccesscontrol

DELETE /api/teams/{team_id}

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

team_id1 / 1

#validinvalidschema

13n/a{

23n/a "type": "string"

33n/a}

Responses1 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

409ConflictError0never seen

500InternalServerError is a general error indicating something went wrong internally.33ms

GET /api/teams/{team_id}

2parameters

2keywords

100%

Path Parameters1 of 1 keywords covered

team_id1 / 1

#validinvalidschema

19n/a{

29n/a "type": "string"

39n/a}

Query Parameters1 of 1 keywords covered

accesscontrol1 / 1

145{

245 "type": "boolean"

345}

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.93ms

Examples1 / 1 used

Query

falseaccesscontrol

PUT /api/teams/{team_id}

2parameters

5keywords

100%

Path Parameters1 of 1 keywords covered

team_id1 / 1

#validinvalidschema

1122n/a{

2122n/a "type": "string"

3122n/a}

Body4 of 4 keywords covered

application/json4 / 4

UpdateTeamCommand

13428{

21923 "properties": {

32218 "email": {

42218 "type": "string"

52218 },

62111 "name": {

72111 "type": "string"

82111 }

91923 },

10575 "type": "object"

113428}

Responses2 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.443ms

409ConflictError0never seen

500InternalServerError is a general error indicating something went wrong internally.134ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request653ms

GET /api/teams/{team_id}/members

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

team_id1 / 1

#validinvalidschema

15n/a{

25n/a "type": "string"

35n/a}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)23ms

401UnauthorizedError is returned when the request is not authenticated.31ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

POST /api/teams/{team_id}/members

2parameters

6keywords

100%

Path Parameters1 of 1 keywords covered

team_id1 / 1

#validinvalidschema

1122n/a{

2122n/a "type": "string"

3122n/a}

Body5 of 5 keywords covered

application/json5 / 5

AddTeamMemberCommand

19820{

29812 "properties": {

39812 "userId": {

49812 "format": "int64",

51028 "type": "integer"

69812 }

79812 },

81102 "required": [

91102 "userId"

101102 ],

111126 "type": "object"

129820}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.11ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.423ms

500InternalServerError is a general error indicating something went wrong internally.594ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request203ms

PUT /api/teams/{team_id}/members

2parameters

7keywords

100%

Path Parameters1 of 1 keywords covered

team_id1 / 1

#validinvalidschema

1134n/a{

2134n/a "type": "string"

3134n/a}

Body6 of 6 keywords covered

application/json6 / 6

SetTeamMembershipsCommand

16063{

24053 "properties": {

34243 "admins": {

44234 "items": {

588109 "type": "string"

64234 },

7769 "type": "array"

84243 },

93742 "members": {

103732 "items": {

11114146 "type": "string"

123732 },

136910 "type": "array"

143742 }

154053 },

1611310 "type": "object"

176063}

Responses3 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.31ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.863ms

500InternalServerError is a general error indicating something went wrong internally.193ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request263ms

DELETE /api/teams/{team_id}/members/{user_id}

2parameters

3keywords

100%

Path Parameters3 of 3 keywords covered

team_id1 / 1

#validinvalidschema

113n/a{

213n/a "type": "string"

313n/a}

user_id2 / 2

167{

267 "format": "int64",

376 "type": "integer"

467}

Responses1 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.63ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request73ms

PUT /api/teams/{team_id}/members/{user_id}

3parameters

8keywords

100%

Path Parameters3 of 3 keywords covered

team_id1 / 1

#validinvalidschema

1132n/a{

2132n/a "type": "string"

3132n/a}

user_id2 / 2

110527{

210527 "format": "int64",

310626 "type": "integer"

410527}

Body5 of 5 keywords covered

application/json5 / 5

UpdateTeamMemberCommand

110515{

22810 "properties": {

32810 "permission": {

42810 "$ref": "#/components/schemas/PermissionType"

52810 }

62810 },

71155 "type": "object"

810515}

Referenced Components (1)2 of 2 keywords

PermissionType2 of 2 keywords

12810{

22810 "format": "int64",

3317 "type": "integer"

42810}

Responses2 of 5 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.923ms

500InternalServerError is a general error indicating something went wrong internally.123ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request283ms

GET /api/teams/{team_id}/preferences

1parameter

1keyword

100%

Path Parameters1 of 1 keywords covered

team_id1 / 1

#validinvalidschema

12n/a{

22n/a "type": "string"

32n/a}

Responses0 of 3 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found23ms

PUT /api/teams/{team_id}/preferences

2parameters

20keywords

100%

Path Parameters1 of 1 keywords covered

team_id1 / 1

#validinvalidschema

1192n/a{

2192n/a "type": "string"

3192n/a}

Body19 of 19 keywords covered

application/json19 / 19

UpdatePrefsCmd

16768{

25461 "properties": {

3799 "homeDashboardId": {

4799 "format": "int64",

5826 "type": "integer"

6799 },

7866 "homeDashboardUID": {

8866 "type": "string"

9866 },

10855 "language": {

11855 "type": "string"

12855 },

138015 "navbar": {

148015 "$ref": "#/components/schemas/NavbarPreference"

158015 },

168610 "queryHistory": {

178610 "$ref": "#/components/schemas/QueryHistoryPreference"

188610 },

19846 "theme": {

20846 "enum": [

2170n/a "light",

2212n/a "dark",

232n/a "system"

24846 ],

25855 "type": "string"

26846 },

27956 "timezone": {

28956 "type": "string"

29956 },

30815 "weekStart": {

31815 "type": "string"

32815 }

335461 },

341287 "type": "object"

356768}

Referenced Components (2)9 of 9 keywords

NavbarPreference5 of 5 keywords

18015{

26910 "properties": {

36910 "bookmarkUrls": {

4695 "items": {

5855 "type": "string"

6695 },

7745 "type": "array"

86910 }

96910 },

10905 "type": "object"

118015}

QueryHistoryPreference4 of 4 keywords

18610{

2745 "properties": {

3745 "homeTab": {

4745 "type": "string"

5745 }

6745 },

7915 "type": "object"

88610}

Responses1 of 4 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

400BadRequestError is returned when the request is invalid and it cannot be processed.1063ms

401UnauthorizedError is returned when the request is not authenticated.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found863ms

Examples1 / 1 used

Body: application/json

0UpdatePrefsCmd.homeDashboardId

user 1 operation 1 covered 0 partial 0 uncovered 0 not measured —

#

GET /api/user/email/update

0parameters

0keywords

—

Responses0 of 1 documented received

codedescriptionhitsavg

302An OKResponse is returned if the request was successful.0never seen

Undocumented - not in spec

codedescriptionhitsavg

404Not Found323ms

401Unauthorized700ms

users 7 operations 7 covered 0 partial 0 uncovered 0 not measured 100%

#

GET /api/users

2parameters

4keywords

100%

Query Parameters4 of 4 keywords covered

perpage2 / 2

#validinvalidschema

13867{

23867 "format": "int64",

34362 "type": "integer"

43867}

page2 / 2

14425{

24425 "format": "int64",

34623 "type": "integer"

44425}

Responses2 of 4 documented received

codedescriptionhitsavg

200(empty)1294ms

401UnauthorizedError is returned when the request is not authenticated.141ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

Examples2 / 2 used

Query

1000perpage

1page

GET /api/users/lookup

1parameter

1keyword

100%

Query Parameters1 of 1 keywords covered

loginOrEmail1 / 1

#validinvalidschema

1102n/a{

2102n/a "type": "string"

3102n/a}

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.481ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.554ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/users/search

0parameters

0keywords

—

Responses2 of 5 documented received

codedescriptionhitsavg

200(empty)304ms

401UnauthorizedError is returned when the request is not authenticated.750ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.0never seen

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/users/{user_id}

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

157{

257 "format": "int64",

366 "type": "integer"

457}

Responses1 of 5 documented received

codedescriptionhitsavg

200(empty)0never seen

401UnauthorizedError is returned when the request is not authenticated.0never seen

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.123ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

PUT /api/users/{user_id}

2parameters

8keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

11388{

21388 "format": "int64",

31397 "type": "integer"

41388}

Body6 of 6 keywords covered

application/json6 / 6

UpdateUserCommand

16229{

23824 "properties": {

3429 "email": {

4429 "type": "string"

5429 },

6399 "login": {

7399 "type": "string"

8399 },

9395 "name": {

10395 "type": "string"

11395 },

12445 "theme": {

13445 "type": "string"

14445 }

153824 },

16865 "type": "object"

176229}

Responses3 of 6 documented received

codedescriptionhitsavg

200An OKResponse is returned if the request was successful.0never seen

401UnauthorizedError is returned when the request is not authenticated.21ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.83ms

409ConflictError0never seen

500InternalServerError is a general error indicating something went wrong internally.134ms

Undocumented - not in spec

codedescriptionhitsavg

400Bad Request1233ms

GET /api/users/{user_id}/orgs

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

187{

287 "format": "int64",

396 "type": "integer"

487}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)53ms

401UnauthorizedError is returned when the request is not authenticated.31ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.73ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

GET /api/users/{user_id}/teams

1parameter

2keywords

100%

Path Parameters2 of 2 keywords covered

user_id2 / 2

#validinvalidschema

187{

287 "format": "int64",

396 "type": "integer"

487}

Responses3 of 5 documented received

codedescriptionhitsavg

200(empty)53ms

401UnauthorizedError is returned when the request is not authenticated.31ms

403ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.0never seen

404NotFoundError is returned when the requested resource was not found.73ms

500InternalServerError is a general error indicating something went wrong internally.0never seen

Method	Host	Path	Reason	Count
DELETE	0.0.0.0:41289	/api/access-control/roles	method not documented	1
DELETE	0.0.0.0:41289	/api/access-control/roles/{roleUID}/assignments	method not documented	1
DELETE	0.0.0.0:41289	/api/access-control/status	method not documented	1
DELETE	0.0.0.0:41289	/api/access-control/teams/roles/search	method not documented	1
DELETE	0.0.0.0:41289	/api/access-control/teams/{teamId}/roles	method not documented	1
DELETE	0.0.0.0:41289	/api/access-control/users/roles/search	method not documented	1
DELETE	0.0.0.0:41289	/api/access-control/users/{userId}/roles	method not documented	1
DELETE	0.0.0.0:41289	/api/access-control/{resource}/description	method not documented	1
DELETE	0.0.0.0:41289	/api/access-control/{resource}/{resourceID}	method not documented	1
DELETE	0.0.0.0:41289	/api/access-control/{resource}/{resourceID}/builtInRoles/{builtInRole}	method not documented	1