Interface IOrganizationsWebhooksHttpServers

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

public interface IOrganizationsWebhooksHttpServers

Methods

CreateOrganizationWebhooksHttpServerAsync(string, WebhookHttpServer, CancellationToken)

Add an HTTP server to an organization

[Post("/organizations/{organizationId}/webhooks/httpServers")]
Task<WebhookHttpServer> CreateOrganizationWebhooksHttpServerAsync(string organizationId, WebhookHttpServer httpServer, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

httpServer WebhookHttpServer

Body for creating an organization HTTP server

cancellationToken CancellationToken

Returns

Task<WebhookHttpServer>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationWebhooksHttpServerAsync(string, string, CancellationToken)

Delete an HTTP server from an organization

[Delete("/organizations/{organizationId}/webhooks/httpServers/{id}")]
Task DeleteOrganizationWebhooksHttpServerAsync(string organizationId, string id, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

id string

The id of a HTTP server

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationWebhooksHttpServerAsync(string, string, CancellationToken)

Return an HTTP server for an organization

[Get("/organizations/{organizationId}/webhooks/httpServers/{id}")]
Task<WebhookHttpServer> GetOrganizationWebhooksHttpServerAsync(string organizationId, string id, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

id string

The id of a HTTP server

cancellationToken CancellationToken

Returns

Task<WebhookHttpServer>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationWebhooksHttpServersAsync(string, CancellationToken)

List the HTTP servers for an organization

[Get("/organizations/{organizationId}/webhooks/httpServers")]
Task<List<WebhookHttpServer>> GetOrganizationWebhooksHttpServersAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<List<WebhookHttpServer>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationWebhooksHttpServerAsync(string, string, WebhookHttpServer, CancellationToken)

Update an HTTP server

[Put("/organizations/{organizationId}/webhooks/httpServers/{id}")]
Task<WebhookHttpServer> UpdateOrganizationWebhooksHttpServerAsync(string organizationId, string id, WebhookHttpServer httpServer, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

id string

The id of a HTTP server

httpServer WebhookHttpServer

Body for updating an organization HTTP server

cancellationToken CancellationToken

Returns

Task<WebhookHttpServer>

Exceptions

ApiException

Thrown when fails to make API call