Skip to content

Latest commit

 

History

History
260 lines (177 loc) · 7.08 KB

PagesApi.md

File metadata and controls

260 lines (177 loc) · 7.08 KB
Raw

OpenAPI\Client\PagesApi

All URIs are relative to https://api.statuspage.io/v1, except if the operation defines another base path.

Method HTTP request Description
getPages() GET /pages Get a list of pages
getPagesPageId() GET /pages/{page_id} Get a page
patchPagesPageId() PATCH /pages/{page_id} Update a page
putPagesPageId() PUT /pages/{page_id} Update a page

getPages()

getPages(): \OpenAPI\Client\Model\Page[]

Get a list of pages

Get a list of pages

Example

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


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


$apiInstance = new OpenAPI\Client\Api\PagesApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\Page[]

Authorization

api_key

HTTP request headers

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

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

getPagesPageId()

getPagesPageId($page_id): \OpenAPI\Client\Model\Page

Get a page

Get a page

Example

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


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


$apiInstance = new OpenAPI\Client\Api\PagesApi(
    // 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
);
$page_id = 'page_id_example'; // string | Page identifier

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

Parameters

Name Type Description Notes
page_id string Page identifier

Return type

\OpenAPI\Client\Model\Page

Authorization

api_key

HTTP request headers

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

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

patchPagesPageId()

patchPagesPageId($page_id, $patch_pages): \OpenAPI\Client\Model\Page

Update a page

Update a page

Example

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


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


$apiInstance = new OpenAPI\Client\Api\PagesApi(
    // 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
);
$page_id = 'page_id_example'; // string | Page identifier
$patch_pages = new \OpenAPI\Client\Model\PatchPages(); // \OpenAPI\Client\Model\PatchPages

try {
    $result = $apiInstance->patchPagesPageId($page_id, $patch_pages);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PagesApi->patchPagesPageId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
page_id string Page identifier
patch_pages \OpenAPI\Client\Model\PatchPages

Return type

\OpenAPI\Client\Model\Page

Authorization

api_key

HTTP request headers

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

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

putPagesPageId()

putPagesPageId($page_id, $put_pages): \OpenAPI\Client\Model\Page

Update a page

Update a page

Example

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


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


$apiInstance = new OpenAPI\Client\Api\PagesApi(
    // 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
);
$page_id = 'page_id_example'; // string | Page identifier
$put_pages = new \OpenAPI\Client\Model\PutPages(); // \OpenAPI\Client\Model\PutPages

try {
    $result = $apiInstance->putPagesPageId($page_id, $put_pages);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PagesApi->putPagesPageId: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
page_id string Page identifier
put_pages \OpenAPI\Client\Model\PutPages

Return type

\OpenAPI\Client\Model\Page

Authorization

api_key

HTTP request headers

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

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