Search

POST

Returns metadata about secrets that match a given query.

Request

This endpoint expects an object.

queryobjectRequired

sortobjectRequired

pageSizeintegerOptional

Defaults to 100. Will throw if larger than 1000.

tokenstringOptional

archivedStatusesset of "NOT_ARCHIVED" or "ARCHIVED"Optional

Allowed values: NOT_ARCHIVEDARCHIVED

Default search status is NOT_ARCHIVED if none are provided. Allows for including archived secrets in search.

Response

This endpoint returns an object.

resultslist of objects

nextPageTokenstringOptional

POST

1 curl -X POST https://api.gov.nominal.io/api/secrets/v1/secrets/search \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "query": {
6     "type": "searchText",
7     "searchText": "query"
8   },
9   "sort": {
10     "isDescending": true,
11     "field": "CREATED_AT"
12   }
13 }'

200Successful

1 {
2   "results": [
3     {
4       "rid": "rid",
5       "name": "name",
6       "description": "description",
7       "createdBy": "createdBy",
8       "properties": {
9         "properties": "properties"
10       },
11       "labels": [
12         "labels"
13       ],
14       "createdAt": "2024-01-15T09:30:00Z",
15       "isArchived": true
16     },
17     {
18       "rid": "rid",
19       "name": "name",
20       "description": "description",
21       "createdBy": "createdBy",
22       "properties": {
23         "properties": "properties"
24       },
25       "labels": [
26         "labels"
27       ],
28       "createdAt": "2024-01-15T09:30:00Z",
29       "isArchived": true
30     }
31   ],
32   "nextPageToken": "nextPageToken"
33 }

Batch Get

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/secrets/v1/secrets/search \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"query": {
6	"type": "searchText",
7	"searchText": "query"
8	},
9	"sort": {
10	"isDescending": true,
11	"field": "CREATED_AT"
12	}
13	}'

1	{
2	"results": [
3	{
4	"rid": "rid",
5	"name": "name",
6	"description": "description",
7	"createdBy": "createdBy",
8	"properties": {
9	"properties": "properties"
10	},
11	"labels": [
12	"labels"
13	],
14	"createdAt": "2024-01-15T09:30:00Z",
15	"isArchived": true
16	},
17	{
18	"rid": "rid",
19	"name": "name",
20	"description": "description",
21	"createdBy": "createdBy",
22	"properties": {
23	"properties": "properties"
24	},
25	"labels": [
26	"labels"
27	],
28	"createdAt": "2024-01-15T09:30:00Z",
29	"isArchived": true
30	}
31	],
32	"nextPageToken": "nextPageToken"
33	}