Interface IOrganizationsConfigTemplates

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

public interface IOrganizationsConfigTemplates

Methods

CreateOrganizationConfigTemplateAsync(string, ConfigurationTemplateCreateRequest, CancellationToken)

Create a new configuration template

[Post("/organizations/{organizationId}/configTemplates")]
Task<ConfigurationTemplate> CreateOrganizationConfigTemplateAsync(string organizationId, ConfigurationTemplateCreateRequest createOrganizationConfigTemplate, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

createOrganizationConfigTemplate ConfigurationTemplateCreateRequest

The config template data

cancellationToken CancellationToken

Returns

Task<ConfigurationTemplate>

Exceptions

ApiException

Thrown when fails to make API call

DeleteOrganizationConfigTemplateAsync(string, string, CancellationToken)

Remove a configuration template

[Delete("/organizations/{organizationId}/configTemplates/{configTemplateId}")]
Task DeleteOrganizationConfigTemplateAsync(string organizationId, string configTemplateId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

configTemplateId string

The config template id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationConfigTemplateAsync(string, string, CancellationToken)

Return a single configuration template

[Get("/organizations/{organizationId}/configTemplates/{configTemplateId}")]
Task<ConfigurationTemplate> GetOrganizationConfigTemplateAsync(string organizationId, string configTemplateId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

configTemplateId string

The config template id

cancellationToken CancellationToken

Returns

Task<ConfigurationTemplate>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationConfigTemplatesAsync(string, CancellationToken)

List the configuration templates for this organization

[Get("/organizations/{organizationId}/configTemplates")]
Task<List<ConfigurationTemplate>> GetOrganizationConfigTemplatesAsync(string organizationId, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

cancellationToken CancellationToken

Returns

Task<List<ConfigurationTemplate>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateOrganizationConfigTemplateAsync(string, string, ConfigurationTemplateUpdate, CancellationToken)

Update a configuration template

[Put("/organizations/{organizationId}/configTemplates/{configTemplateId}")]
Task<ConfigurationTemplate> UpdateOrganizationConfigTemplateAsync(string organizationId, string configTemplateId, ConfigurationTemplateUpdate updateOrganizationConfigTemplate, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

configTemplateId string

The config template id

updateOrganizationConfigTemplate ConfigurationTemplateUpdate

Body for updating an organization's config template

cancellationToken CancellationToken

Returns

Task<ConfigurationTemplate>

Exceptions

ApiException

Thrown when fails to make API call