1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
---
title: "Environments endpoint"
layout: default
canonical: "/puppetdb/latest/api/query/v4/environments.html"
---
# Environments endpoint
[curl]: ../curl.markdown#using-curl-from-localhost-non-sslhttp
[paging]: ./paging.markdown
[query]: query.markdown
[subqueries]: ./ast.markdown#subquery-operators
[factsets]: ./factsets.markdown
[reports]: ./reports.markdown
[catalogs]: ./catalogs.markdown
[facts]: ./facts.markdown
[fact-contents]: ./fact-contents.markdown
[events]: ./events.markdown
[resources]: ./resources.markdown
[inventory]: inventory.markdown
Environments are semi-isolated groups of nodes managed by Puppet. Nodes are assigned to environments by their own configuration, or by the Puppet Server's external node classifier.
When PuppetDB collects info about a node, it keeps track of the environment the node is assigned to. PuppetDB also keeps a list of environments it has seen. You can query this list by making an HTTP request to the `/environments` endpoint.
## `/pdb/query/v4/environments`
This will return all environments known to PuppetDB.
### URL parameters
* `query`: optional. A JSON array containing the query in prefix notation. If
not provided, all results will be returned. See the sections below for the
supported operators and fields. For general info about queries,
see [our guide to query structure.][query]
### Query operators
See [the AST query language page](./ast.markdown)
### Query fields
* `name` (string): the name of an environment.
### Subquery relationships
The following list contains related entities that can be used to constrain the result set by using implicit subqueries. For more information, consult the documentation for [subqueries][subqueries].
* [`inventory`][inventory]: inventory for an environment.
* [`factsets`][factsets]: factsets received for an environment.
* [`reports`][reports]: reports received for an environment.
* [`catalogs`][catalogs]: catalogs received for an environment.
* [`facts`][facts]: fact names and values received for an environment.
* [`fact_contents`][fact-contents]: fact paths and values received for an environment.
* [`events`][events]: report events triggered for an environment.
* [`resources`][resources]: catalog resources received for an environment.
### Response format
The response is a JSON array of hashes, where each hash has the form:
{"name": <string>}
The array is unsorted.
### Example
[You can use `curl`][curl] to query information about nodes:
curl 'http://localhost:8080/pdb/query/v4/environments'
## `/pdb/query/v4/environments/<ENVIRONMENT>`
This will return the name of the environment if it currently exists in PuppetDB.
### URL parameters / query operators / query fields
This route supports the same URL parameters and query fields/operators
as the '/pdb/query/v4/environments' route above.
### Response format
The response is a JSON hash of the form:
{"name": <string>}
### Examples
[You can use `curl`][curl] to query information about nodes like so:
curl 'http://localhost:8080/pdb/query/v4/environments/production'
{
"name" : "production"
}
## `/pdb/query/v4/environments/<ENVIRONMENT>/[events|facts|reports|resources]`
These routes are identical to issuing a request to
`/pdb/query/v4/[events|facts|reports|resources]`, with a query
parameter of `["=","environment","<ENVIRONMENT>"]`. All query
parameters and route suffixes from the original routes are
supported. The result format is also the same. Additional query
parameters are ANDed with the environment clause. See
[/pdb/query/v4/events][events], [/pdb/query/v4/facts][facts],
[/pdb/query/v4/reports][reports], or
[/pdb/query/v4/resources][resources] for more information.
## Paging
This query endpoint supports paged results via the common PuppetDB paging
URL parameters. For more information, please see the documentation
on [paging][paging].
|
