Skip to content
This repository was archived by the owner on Feb 3, 2026. It is now read-only.

AnnouncementsApi.md

Latest commit

 

History

History
264 lines (181 loc) · 8.71 KB

AnnouncementsApi.md

File metadata and controls

264 lines (181 loc) · 8.71 KB

LaunchDarklyApi\AnnouncementsApi

All URIs are relative to https://app.launchdarkly.com, except if the operation defines another base path.

Method HTTP request Description
createAnnouncementPublic() POST /api/v2/announcements Create an announcement
deleteAnnouncementPublic() DELETE /api/v2/announcements/{announcementId} Delete an announcement
getAnnouncementsPublic() GET /api/v2/announcements Get announcements
updateAnnouncementPublic() PATCH /api/v2/announcements/{announcementId} Update an announcement

createAnnouncementPublic()

createAnnouncementPublic($create_announcement_body): \LaunchDarklyApi\Model\AnnouncementResponse

Create an announcement

Create an announcement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\AnnouncementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$create_announcement_body = new \LaunchDarklyApi\Model\CreateAnnouncementBody(); // \LaunchDarklyApi\Model\CreateAnnouncementBody | Announcement request body

try {
    $result = $apiInstance->createAnnouncementPublic($create_announcement_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnouncementsApi->createAnnouncementPublic: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
create_announcement_body \LaunchDarklyApi\Model\CreateAnnouncementBody Announcement request body

Return type

\LaunchDarklyApi\Model\AnnouncementResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteAnnouncementPublic()

deleteAnnouncementPublic($announcement_id)

Delete an announcement

Delete an announcement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\AnnouncementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$announcement_id = 1234567890; // string

try {
    $apiInstance->deleteAnnouncementPublic($announcement_id);
} catch (Exception $e) {
    echo 'Exception when calling AnnouncementsApi->deleteAnnouncementPublic: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
announcement_id string

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAnnouncementsPublic()

getAnnouncementsPublic($status, $limit, $offset): \LaunchDarklyApi\Model\GetAnnouncementsPublic200Response

Get announcements

Get announcements

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\AnnouncementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$status = active; // string | Filter announcements by status.
$limit = 56; // int | The number of announcements to return.
$offset = 56; // int | 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`.

try {
    $result = $apiInstance->getAnnouncementsPublic($status, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnouncementsApi->getAnnouncementsPublic: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
status string Filter announcements by status. [optional]
limit int The number of announcements to return. [optional]
offset int 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`. [optional]

Return type

\LaunchDarklyApi\Model\GetAnnouncementsPublic200Response

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateAnnouncementPublic()

updateAnnouncementPublic($announcement_id, $announcement_patch_operation): \LaunchDarklyApi\Model\AnnouncementResponse

Update an announcement

Update an announcement

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: ApiKey
$config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LaunchDarklyApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new LaunchDarklyApi\Api\AnnouncementsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$announcement_id = 1234567890; // string
$announcement_patch_operation = array(new \LaunchDarklyApi\Model\AnnouncementPatchOperation()); // \LaunchDarklyApi\Model\AnnouncementPatchOperation[] | Update announcement request body

try {
    $result = $apiInstance->updateAnnouncementPublic($announcement_id, $announcement_patch_operation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnouncementsApi->updateAnnouncementPublic: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
announcement_id string
announcement_patch_operation \LaunchDarklyApi\Model\AnnouncementPatchOperation[] Update announcement request body

Return type

\LaunchDarklyApi\Model\AnnouncementResponse

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]