\PublicStatusPageApi

All URIs are relative to https://api.uptrends.com/v4

Method	HTTP request	Description
PublicStatusPageAddAuthorizationToPublicStatusPage	Post /PublicStatusPage/{publicStatusPageGuid}/Authorization	Creates a new authorization for the specified public status page.
PublicStatusPageDeletePublicStatusPage	Delete /PublicStatusPage/{publicStatusPageGuid}	Deletes the definition of the specified public status page.
PublicStatusPageGetAuthorizationsForPublicStatusPage	Get /PublicStatusPage/{publicStatusPageGuid}/Authorization	Returns all authorizations for the specified public status page.
PublicStatusPageGetPublicStatusPage	Get /PublicStatusPage/{publicStatusPageGuid}	Returns the definition of the specified public status page.
PublicStatusPageGetPublicStatusPages	Get /PublicStatusPage	Returns the definition of all public status pages available in the account.
PublicStatusPagePatchPublicStatusPage	Patch /PublicStatusPage/{publicStatusPageGuid}	Partially updates the definition of the specified public status page.
PublicStatusPagePostPublicStatusPage	Post /PublicStatusPage	Creates a new public status page.
PublicStatusPagePutPublicStatusPage	Put /PublicStatusPage/{publicStatusPageGuid}	Updates the definition of the specified public status page.
PublicStatusPageRemoveAuthorizationFromPublicStatusPage	Delete /PublicStatusPage/{publicStatusPageGuid}/Authorization/{authorizationGuid}	Removes an authorization from a public status page.

PublicStatusPageAddAuthorizationToPublicStatusPage

PSPAuthorization PublicStatusPageAddAuthorizationToPublicStatusPage(ctx, publicStatusPageGuid).Authorization(authorization).Execute()

Creates a new authorization for the specified public status page.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    publicStatusPageGuid := "publicStatusPageGuid_example" // string | The Guid of the public status page.
    authorization := *openapiclient.NewPSPAuthorization(map[string][]openapiclient.PSPAuthorizationType{ ... }) // PSPAuthorization | The complete definition of the authorization that should be created. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PublicStatusPageApi.PublicStatusPageAddAuthorizationToPublicStatusPage(context.Background(), publicStatusPageGuid).Authorization(authorization).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PublicStatusPageApi.PublicStatusPageAddAuthorizationToPublicStatusPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PublicStatusPageAddAuthorizationToPublicStatusPage`: PSPAuthorization
    fmt.Fprintf(os.Stdout, "Response from `PublicStatusPageApi.PublicStatusPageAddAuthorizationToPublicStatusPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
publicStatusPageGuid	string	The Guid of the public status page.

Other Parameters

Other parameters are passed through a pointer to a apiPublicStatusPageAddAuthorizationToPublicStatusPageRequest struct via the builder pattern

Name	Type	Description	Notes

authorization | PSPAuthorization | The complete definition of the authorization that should be created. |

Return type

PSPAuthorization

Authorization

basicauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

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

PublicStatusPageDeletePublicStatusPage

PublicStatusPageDeletePublicStatusPage(ctx, publicStatusPageGuid).Execute()

Deletes the definition of the specified public status page.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    publicStatusPageGuid := "publicStatusPageGuid_example" // string | The Guid of the public status page that should be updated.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PublicStatusPageApi.PublicStatusPageDeletePublicStatusPage(context.Background(), publicStatusPageGuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PublicStatusPageApi.PublicStatusPageDeletePublicStatusPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
publicStatusPageGuid	string	The Guid of the public status page that should be updated.

Other Parameters

Other parameters are passed through a pointer to a apiPublicStatusPageDeletePublicStatusPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

PublicStatusPageGetAuthorizationsForPublicStatusPage

[]PSPAuthorization PublicStatusPageGetAuthorizationsForPublicStatusPage(ctx, publicStatusPageGuid).Execute()

Returns all authorizations for the specified public status page.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    publicStatusPageGuid := "publicStatusPageGuid_example" // string | The Guid of the public status page.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PublicStatusPageApi.PublicStatusPageGetAuthorizationsForPublicStatusPage(context.Background(), publicStatusPageGuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PublicStatusPageApi.PublicStatusPageGetAuthorizationsForPublicStatusPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PublicStatusPageGetAuthorizationsForPublicStatusPage`: []PSPAuthorization
    fmt.Fprintf(os.Stdout, "Response from `PublicStatusPageApi.PublicStatusPageGetAuthorizationsForPublicStatusPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
publicStatusPageGuid	string	The Guid of the public status page.

Other Parameters

Other parameters are passed through a pointer to a apiPublicStatusPageGetAuthorizationsForPublicStatusPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]PSPAuthorization

Authorization

basicauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

PublicStatusPageGetPublicStatusPage

PublicStatusPage PublicStatusPageGetPublicStatusPage(ctx, publicStatusPageGuid).Execute()

Returns the definition of the specified public status page.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    publicStatusPageGuid := "publicStatusPageGuid_example" // string | The Guid of the requested public status page.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PublicStatusPageApi.PublicStatusPageGetPublicStatusPage(context.Background(), publicStatusPageGuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PublicStatusPageApi.PublicStatusPageGetPublicStatusPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PublicStatusPageGetPublicStatusPage`: PublicStatusPage
    fmt.Fprintf(os.Stdout, "Response from `PublicStatusPageApi.PublicStatusPageGetPublicStatusPage`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
publicStatusPageGuid	string	The Guid of the requested public status page.

Other Parameters

Other parameters are passed through a pointer to a apiPublicStatusPageGetPublicStatusPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

PublicStatusPage

Authorization

basicauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

PublicStatusPageGetPublicStatusPages

[]PublicStatusPage PublicStatusPageGetPublicStatusPages(ctx).Execute()

Returns the definition of all public status pages available in the account.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PublicStatusPageApi.PublicStatusPageGetPublicStatusPages(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PublicStatusPageApi.PublicStatusPageGetPublicStatusPages``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PublicStatusPageGetPublicStatusPages`: []PublicStatusPage
    fmt.Fprintf(os.Stdout, "Response from `PublicStatusPageApi.PublicStatusPageGetPublicStatusPages`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiPublicStatusPageGetPublicStatusPagesRequest struct via the builder pattern

Return type

[]PublicStatusPage

Authorization

basicauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

PublicStatusPagePatchPublicStatusPage

PublicStatusPagePatchPublicStatusPage(ctx, publicStatusPageGuid).PublicStatusPage(publicStatusPage).Execute()

Partially updates the definition of the specified public status page.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    publicStatusPageGuid := "publicStatusPageGuid_example" // string | The Guid of the public status page that should be updated.
    publicStatusPage := *openapiclient.NewPublicStatusPage() // PublicStatusPage | The partial definition for the public status page that should be updated. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PublicStatusPageApi.PublicStatusPagePatchPublicStatusPage(context.Background(), publicStatusPageGuid).PublicStatusPage(publicStatusPage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PublicStatusPageApi.PublicStatusPagePatchPublicStatusPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
publicStatusPageGuid	string	The Guid of the public status page that should be updated.

Other Parameters

Other parameters are passed through a pointer to a apiPublicStatusPagePatchPublicStatusPageRequest struct via the builder pattern

Name	Type	Description	Notes

publicStatusPage | PublicStatusPage | The partial definition for the public status page that should be updated. |

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

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

PublicStatusPagePostPublicStatusPage

PublicStatusPage PublicStatusPagePostPublicStatusPage(ctx).PublicStatusPage(publicStatusPage).Execute()

Creates a new public status page.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    publicStatusPage := *openapiclient.NewPublicStatusPage() // PublicStatusPage | The complete definition for the public status page that should be updated. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PublicStatusPageApi.PublicStatusPagePostPublicStatusPage(context.Background()).PublicStatusPage(publicStatusPage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PublicStatusPageApi.PublicStatusPagePostPublicStatusPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PublicStatusPagePostPublicStatusPage`: PublicStatusPage
    fmt.Fprintf(os.Stdout, "Response from `PublicStatusPageApi.PublicStatusPagePostPublicStatusPage`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPublicStatusPagePostPublicStatusPageRequest struct via the builder pattern

Name	Type	Description	Notes
publicStatusPage	PublicStatusPage	The complete definition for the public status page that should be updated.

Return type

PublicStatusPage

Authorization

basicauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

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

PublicStatusPagePutPublicStatusPage

PublicStatusPagePutPublicStatusPage(ctx, publicStatusPageGuid).PublicStatusPage(publicStatusPage).Execute()

Updates the definition of the specified public status page.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    publicStatusPageGuid := "publicStatusPageGuid_example" // string | The Guid of the public status page that should be updated.
    publicStatusPage := *openapiclient.NewPublicStatusPage() // PublicStatusPage | The complete definition for the public status page that should be updated. (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PublicStatusPageApi.PublicStatusPagePutPublicStatusPage(context.Background(), publicStatusPageGuid).PublicStatusPage(publicStatusPage).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PublicStatusPageApi.PublicStatusPagePutPublicStatusPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
publicStatusPageGuid	string	The Guid of the public status page that should be updated.

Other Parameters

Other parameters are passed through a pointer to a apiPublicStatusPagePutPublicStatusPageRequest struct via the builder pattern

Name	Type	Description	Notes

publicStatusPage | PublicStatusPage | The complete definition for the public status page that should be updated. |

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json, application/xml

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

PublicStatusPageRemoveAuthorizationFromPublicStatusPage

PublicStatusPageRemoveAuthorizationFromPublicStatusPage(ctx, publicStatusPageGuid, authorizationGuid).Execute()

Removes an authorization from a public status page.

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    publicStatusPageGuid := "publicStatusPageGuid_example" // string | The Guid of the public status page.
    authorizationGuid := "authorizationGuid_example" // string | The Guid of the authorization.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.PublicStatusPageApi.PublicStatusPageRemoveAuthorizationFromPublicStatusPage(context.Background(), publicStatusPageGuid, authorizationGuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `PublicStatusPageApi.PublicStatusPageRemoveAuthorizationFromPublicStatusPage``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
publicStatusPageGuid	string	The Guid of the public status page.
authorizationGuid	string	The Guid of the authorization.

Other Parameters

Other parameters are passed through a pointer to a apiPublicStatusPageRemoveAuthorizationFromPublicStatusPageRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicauth

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/xml

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

Files

PublicStatusPageApi.md

Latest commit

History

PublicStatusPageApi.md

File metadata and controls

\PublicStatusPageApi

PublicStatusPageAddAuthorizationToPublicStatusPage

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PublicStatusPageDeletePublicStatusPage

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PublicStatusPageGetAuthorizationsForPublicStatusPage

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PublicStatusPageGetPublicStatusPage

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PublicStatusPageGetPublicStatusPages

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PublicStatusPagePatchPublicStatusPage

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PublicStatusPagePostPublicStatusPage

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PublicStatusPagePutPublicStatusPage

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

PublicStatusPageRemoveAuthorizationFromPublicStatusPage

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers