Create an announcement

1 import requests 2 3 url = "https://app.launchdarkly.com/api/v2/announcements" 4 5 payload = { 6 "isDismissible": True, 7 "title": "System Maintenance Notice", 8 "message": "**Important Update:** 9 10 Please be aware of the upcoming maintenance scheduled for *October 31st, 2024*. The system will be unavailable from **12:00 AM** to **4:00 AM**.", 11 "startTime": 1731439812, 12 "severity": "warning", 13 "endTime": 1731439880 14 } 15 headers = { 16 "Authorization": "<apiKey>", 17 "Content-Type": "application/json" 18 } 19 20 response = requests.post(url, json=payload, headers=headers) 21 22 print(response.json())

1 { 2 "_id": "1234567890", 3 "isDismissible": true, 4 "title": "System Maintenance Notice", 5 "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**.", 6 "startTime": 1731439812, 7 "severity": "info", 8 "_status": "active", 9 "_links": { 10 "parent": { 11 "href": "href", 12 "type": "type" 13 } 14 }, 15 "endTime": 1731439880, 16 "_access": { 17 "denied": [ 18 { 19 "action": "action", 20 "reason": { 21 "effect": "allow", 22 "resources": [ 23 "proj/*:env/*;qa_*:/flag/*" 24 ], 25 "notResources": [ 26 "notResources", 27 "notResources" 28 ], 29 "actions": [ 30 "*" 31 ], 32 "notActions": [ 33 "notActions", 34 "notActions" 35 ], 36 "role_name": "role_name" 37 } 38 }, 39 { 40 "action": "action", 41 "reason": { 42 "effect": "allow", 43 "resources": [ 44 "proj/*:env/*;qa_*:/flag/*" 45 ], 46 "notResources": [ 47 "notResources", 48 "notResources" 49 ], 50 "actions": [ 51 "*" 52 ], 53 "notActions": [ 54 "notActions", 55 "notActions" 56 ], 57 "role_name": "role_name" 58 } 59 } 60 ], 61 "allowed": [ 62 { 63 "action": "action", 64 "reason": { 65 "effect": "allow", 66 "resources": [ 67 "proj/*:env/*;qa_*:/flag/*" 68 ], 69 "notResources": [ 70 "notResources", 71 "notResources" 72 ], 73 "actions": [ 74 "*" 75 ], 76 "notActions": [ 77 "notActions", 78 "notActions" 79 ], 80 "role_name": "role_name" 81 } 82 }, 83 { 84 "action": "action", 85 "reason": { 86 "effect": "allow", 87 "resources": [ 88 "proj/*:env/*;qa_*:/flag/*" 89 ], 90 "notResources": [ 91 "notResources", 92 "notResources" 93 ], 94 "actions": [ 95 "*" 96 ], 97 "notActions": [ 98 "notActions", 99 "notActions" 100 ], 101 "role_name": "role_name" 102 } 103 } 104 ] 105 } 106 }

Request

This endpoint expects an object.

isDismissiblebooleanRequired

true if the announcement is dismissible

titlestringRequired

The title of the announcement

messagestringRequired

The message of the announcement

startTimelongRequired

The start time of the announcement. This is a Unix timestamp in milliseconds.

severityenumRequired

The severity of the announcement

Allowed values:

endTimelongOptional

The end time of the announcement. This is a Unix timestamp in milliseconds.

Response

Created announcement

_idstring

The ID of the announcement

isDismissibleboolean

true if the announcement is dismissible

titlestring

The title of the announcement

messagestring

The message of the announcement

startTimelong

The start time of the announcement. This is a Unix timestamp in milliseconds.

severityenum

The severity of the announcement

Allowed values:

_statusenum

The status of the announcement

Allowed values:

_linksobject

endTimelong or null

The end time of the announcement. This is a Unix timestamp in milliseconds.

_accessobject or null

Headers

Request

Response

Errors