Get announcements

GET

/api/v2/announcements

GET

/api/v2/announcements

1 import requests
2 
3 url = "https://app.launchdarkly.com/api/v2/announcements"
4 
5 headers = {"Authorization": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

Try it

200Retrieved

1 {
2   "items": [
3     {
4       "_id": "1234567890",
5       "isDismissible": true,
6       "title": "System Maintenance Notice",
7       "message": "**Important Update:**\n\nPlease be aware of the upcoming maintenance scheduled for *October 31st, 2024*. The system will be unavailable from **12:00 AM** to **4:00 AM**.",
8       "startTime": 1731439812,
9       "severity": "info",
10       "_status": "active",
11       "_links": {
12         "parent": {
13           "href": "href",
14           "type": "type"
15         }
16       },
17       "endTime": 1731439880,
18       "_access": {
19         "denied": [
20           {
21             "action": "action",
22             "reason": {
23               "effect": "allow",
24               "resources": [
25                 "proj/*:env/*;qa_*:/flag/*"
26               ],
27               "notResources": [
28                 "notResources",
29                 "notResources"
30               ],
31               "actions": [
32                 "*"
33               ],
34               "notActions": [
35                 "notActions",
36                 "notActions"
37               ],
38               "role_name": "role_name"
39             }
40           },
41           {
42             "action": "action",
43             "reason": {
44               "effect": "allow",
45               "resources": [
46                 "proj/*:env/*;qa_*:/flag/*"
47               ],
48               "notResources": [
49                 "notResources",
50                 "notResources"
51               ],
52               "actions": [
53                 "*"
54               ],
55               "notActions": [
56                 "notActions",
57                 "notActions"
58               ],
59               "role_name": "role_name"
60             }
61           }
62         ],
63         "allowed": [
64           {
65             "action": "action",
66             "reason": {
67               "effect": "allow",
68               "resources": [
69                 "proj/*:env/*;qa_*:/flag/*"
70               ],
71               "notResources": [
72                 "notResources",
73                 "notResources"
74               ],
75               "actions": [
76                 "*"
77               ],
78               "notActions": [
79                 "notActions",
80                 "notActions"
81               ],
82               "role_name": "role_name"
83             }
84           },
85           {
86             "action": "action",
87             "reason": {
88               "effect": "allow",
89               "resources": [
90                 "proj/*:env/*;qa_*:/flag/*"
91               ],
92               "notResources": [
93                 "notResources",
94                 "notResources"
95               ],
96               "actions": [
97                 "*"
98               ],
99               "notActions": [
100                 "notActions",
101                 "notActions"
102               ],
103               "role_name": "role_name"
104             }
105           }
106         ]
107       }
108     },
109     {
110       "_id": "1234567890",
111       "isDismissible": true,
112       "title": "System Maintenance Notice",
113       "message": "**Important Update:**\n\nPlease be aware of the upcoming maintenance scheduled for *October 31st, 2024*. The system will be unavailable from **12:00 AM** to **4:00 AM**.",
114       "startTime": 1731439812,
115       "severity": "info",
116       "_status": "active",
117       "_links": {
118         "parent": {
119           "href": "href",
120           "type": "type"
121         }
122       },
123       "endTime": 1731439880,
124       "_access": {
125         "denied": [
126           {
127             "action": "action",
128             "reason": {
129               "effect": "allow",
130               "resources": [
131                 "proj/*:env/*;qa_*:/flag/*"
132               ],
133               "notResources": [
134                 "notResources",
135                 "notResources"
136               ],
137               "actions": [
138                 "*"
139               ],
140               "notActions": [
141                 "notActions",
142                 "notActions"
143               ],
144               "role_name": "role_name"
145             }
146           },
147           {
148             "action": "action",
149             "reason": {
150               "effect": "allow",
151               "resources": [
152                 "proj/*:env/*;qa_*:/flag/*"
153               ],
154               "notResources": [
155                 "notResources",
156                 "notResources"
157               ],
158               "actions": [
159                 "*"
160               ],
161               "notActions": [
162                 "notActions",
163                 "notActions"
164               ],
165               "role_name": "role_name"
166             }
167           }
168         ],
169         "allowed": [
170           {
171             "action": "action",
172             "reason": {
173               "effect": "allow",
174               "resources": [
175                 "proj/*:env/*;qa_*:/flag/*"
176               ],
177               "notResources": [
178                 "notResources",
179                 "notResources"
180               ],
181               "actions": [
182                 "*"
183               ],
184               "notActions": [
185                 "notActions",
186                 "notActions"
187               ],
188               "role_name": "role_name"
189             }
190           },
191           {
192             "action": "action",
193             "reason": {
194               "effect": "allow",
195               "resources": [
196                 "proj/*:env/*;qa_*:/flag/*"
197               ],
198               "notResources": [
199                 "notResources",
200                 "notResources"
201               ],
202               "actions": [
203                 "*"
204               ],
205               "notActions": [
206                 "notActions",
207                 "notActions"
208               ],
209               "role_name": "role_name"
210             }
211           }
212         ]
213       }
214     }
215   ],
216   "_links": {
217     "self": {
218       "href": "href",
219       "type": "type"
220     },
221     "first": {
222       "href": "href",
223       "type": "type"
224     },
225     "last": {
226       "href": "href",
227       "type": "type"
228     },
229     "next": {
230       "href": "href",
231       "type": "type"
232     },
233     "prev": {
234       "href": "href",
235       "type": "type"
236     }
237   }
238 }

Get announcements

Query parameters

statusenumOptional

Filter announcements by status.

Allowed values:

limitintegerOptional

The number of announcements to return.

offsetintegerOptional

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

Response

Announcement response

itemslist of objects

_linksobject

Get announcements

Headers

Query parameters

Response

Errors