Cisco Meraki v0.2.10, Jul 24 24

Cisco Meraki v0.2.10 published on Wednesday, Jul 24, 2024 by Pulumi

meraki.organizations.getApiRequests

Explore with Pulumi AI

Cisco Meraki v0.2.10 published on Wednesday, Jul 24, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as meraki from "@pulumi/meraki";

const example = meraki.organizations.getApiRequests({
    adminId: "string",
    endingBefore: "string",
    method: "string",
    operationIds: ["string"],
    organizationId: "string",
    path: "string",
    perPage: 1,
    responseCode: 1,
    sourceIp: "string",
    startingAfter: "string",
    t0: "string",
    t1: "string",
    timespan: 1,
    userAgent: "string",
    version: 1,
});
export const merakiOrganizationsApiRequestsExample = example.then(example => example.items);

import pulumi
import pulumi_meraki as meraki

example = meraki.organizations.get_api_requests(admin_id="string",
    ending_before="string",
    method="string",
    operation_ids=["string"],
    organization_id="string",
    path="string",
    per_page=1,
    response_code=1,
    source_ip="string",
    starting_after="string",
    t0="string",
    t1="string",
    timespan=1,
    user_agent="string",
    version=1)
pulumi.export("merakiOrganizationsApiRequestsExample", example.items)

package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/organizations"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := organizations.GetApiRequests(ctx, &organizations.GetApiRequestsArgs{
			AdminId:      pulumi.StringRef("string"),
			EndingBefore: pulumi.StringRef("string"),
			Method:       pulumi.StringRef("string"),
			OperationIds: []string{
				"string",
			},
			OrganizationId: "string",
			Path:           pulumi.StringRef("string"),
			PerPage:        pulumi.IntRef(1),
			ResponseCode:   pulumi.IntRef(1),
			SourceIp:       pulumi.StringRef("string"),
			StartingAfter:  pulumi.StringRef("string"),
			T0:             pulumi.StringRef("string"),
			T1:             pulumi.StringRef("string"),
			Timespan:       pulumi.Float64Ref(1),
			UserAgent:      pulumi.StringRef("string"),
			Version:        pulumi.IntRef(1),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("merakiOrganizationsApiRequestsExample", example.Items)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = Meraki.Organizations.GetApiRequests.Invoke(new()
    {
        AdminId = "string",
        EndingBefore = "string",
        Method = "string",
        OperationIds = new[]
        {
            "string",
        },
        OrganizationId = "string",
        Path = "string",
        PerPage = 1,
        ResponseCode = 1,
        SourceIp = "string",
        StartingAfter = "string",
        T0 = "string",
        T1 = "string",
        Timespan = 1,
        UserAgent = "string",
        Version = 1,
    });

    return new Dictionary<string, object?>
    {
        ["merakiOrganizationsApiRequestsExample"] = example.Apply(getApiRequestsResult => getApiRequestsResult.Items),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.organizations.OrganizationsFunctions;
import com.pulumi.meraki.organizations.inputs.GetApiRequestsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = OrganizationsFunctions.getApiRequests(GetApiRequestsArgs.builder()
            .adminId("string")
            .endingBefore("string")
            .method("string")
            .operationIds("string")
            .organizationId("string")
            .path("string")
            .perPage(1)
            .responseCode(1)
            .sourceIp("string")
            .startingAfter("string")
            .t0("string")
            .t1("string")
            .timespan(1)
            .userAgent("string")
            .version(1)
            .build());

        ctx.export("merakiOrganizationsApiRequestsExample", example.applyValue(getApiRequestsResult -> getApiRequestsResult.items()));
    }
}

variables:
  example:
    fn::invoke:
      Function: meraki:organizations:getApiRequests
      Arguments:
        adminId: string
        endingBefore: string
        method: string
        operationIds:
          - string
        organizationId: string
        path: string
        perPage: 1
        responseCode: 1
        sourceIp: string
        startingAfter: string
        t0: string
        t1: string
        timespan: 1
        userAgent: string
        version: 1
outputs:
  merakiOrganizationsApiRequestsExample: ${example.items}

Using getApiRequests

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApiRequests(args: GetApiRequestsArgs, opts?: InvokeOptions): Promise<GetApiRequestsResult>
function getApiRequestsOutput(args: GetApiRequestsOutputArgs, opts?: InvokeOptions): Output<GetApiRequestsResult>

def get_api_requests(admin_id: Optional[str] = None,
                     ending_before: Optional[str] = None,
                     method: Optional[str] = None,
                     operation_ids: Optional[Sequence[str]] = None,
                     organization_id: Optional[str] = None,
                     path: Optional[str] = None,
                     per_page: Optional[int] = None,
                     response_code: Optional[int] = None,
                     source_ip: Optional[str] = None,
                     starting_after: Optional[str] = None,
                     t0: Optional[str] = None,
                     t1: Optional[str] = None,
                     timespan: Optional[float] = None,
                     user_agent: Optional[str] = None,
                     version: Optional[int] = None,
                     opts: Optional[InvokeOptions] = None) -> GetApiRequestsResult
def get_api_requests_output(admin_id: Optional[pulumi.Input[str]] = None,
                     ending_before: Optional[pulumi.Input[str]] = None,
                     method: Optional[pulumi.Input[str]] = None,
                     operation_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     organization_id: Optional[pulumi.Input[str]] = None,
                     path: Optional[pulumi.Input[str]] = None,
                     per_page: Optional[pulumi.Input[int]] = None,
                     response_code: Optional[pulumi.Input[int]] = None,
                     source_ip: Optional[pulumi.Input[str]] = None,
                     starting_after: Optional[pulumi.Input[str]] = None,
                     t0: Optional[pulumi.Input[str]] = None,
                     t1: Optional[pulumi.Input[str]] = None,
                     timespan: Optional[pulumi.Input[float]] = None,
                     user_agent: Optional[pulumi.Input[str]] = None,
                     version: Optional[pulumi.Input[int]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetApiRequestsResult]

func GetApiRequests(ctx *Context, args *GetApiRequestsArgs, opts ...InvokeOption) (*GetApiRequestsResult, error)
func GetApiRequestsOutput(ctx *Context, args *GetApiRequestsOutputArgs, opts ...InvokeOption) GetApiRequestsResultOutput

> Note: This function is named GetApiRequests in the Go SDK.

public static class GetApiRequests 
{
    public static Task<GetApiRequestsResult> InvokeAsync(GetApiRequestsArgs args, InvokeOptions? opts = null)
    public static Output<GetApiRequestsResult> Invoke(GetApiRequestsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiRequestsResult> getApiRequests(GetApiRequestsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: meraki:organizations/getApiRequests:getApiRequests
  arguments:
    # arguments dictionary

The following arguments are supported:

OrganizationId string: organizationId path parameter. Organization ID
AdminId string: adminId query parameter. Filter the results by the ID of the admin who made the API requests
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
Method string: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
OperationIds List<string>: operationIds query parameter. Filter the results by one or more operation IDs for the API request
Path string: path query parameter. Filter the results by the path of the API requests
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
ResponseCode int: responseCode query parameter. Filter the results by the response code of the API requests
SourceIp string: sourceIp query parameter. Filter the results by the IP address of the originating API request
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
T0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
T1 string: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
Timespan double: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
UserAgent string: userAgent query parameter. Filter the results by the user agent string of the API request
Version int: version query parameter. Filter the results by the API version of the API request

OrganizationId string: organizationId path parameter. Organization ID
AdminId string: adminId query parameter. Filter the results by the ID of the admin who made the API requests
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
Method string: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
OperationIds []string: operationIds query parameter. Filter the results by one or more operation IDs for the API request
Path string: path query parameter. Filter the results by the path of the API requests
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
ResponseCode int: responseCode query parameter. Filter the results by the response code of the API requests
SourceIp string: sourceIp query parameter. Filter the results by the IP address of the originating API request
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
T0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
T1 string: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
Timespan float64: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
UserAgent string: userAgent query parameter. Filter the results by the user agent string of the API request
Version int: version query parameter. Filter the results by the API version of the API request

organizationId String: organizationId path parameter. Organization ID
adminId String: adminId query parameter. Filter the results by the ID of the admin who made the API requests
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
method String: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
operationIds List<String>: operationIds query parameter. Filter the results by one or more operation IDs for the API request
path String: path query parameter. Filter the results by the path of the API requests
perPage Integer: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
responseCode Integer: responseCode query parameter. Filter the results by the response code of the API requests
sourceIp String: sourceIp query parameter. Filter the results by the IP address of the originating API request
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
t0 String: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 String: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan Double: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
userAgent String: userAgent query parameter. Filter the results by the user agent string of the API request
version Integer: version query parameter. Filter the results by the API version of the API request

organizationId string: organizationId path parameter. Organization ID
adminId string: adminId query parameter. Filter the results by the ID of the admin who made the API requests
endingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
method string: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
operationIds string[]: operationIds query parameter. Filter the results by one or more operation IDs for the API request
path string: path query parameter. Filter the results by the path of the API requests
perPage number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
responseCode number: responseCode query parameter. Filter the results by the response code of the API requests
sourceIp string: sourceIp query parameter. Filter the results by the IP address of the originating API request
startingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
t0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 string: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan number: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
userAgent string: userAgent query parameter. Filter the results by the user agent string of the API request
version number: version query parameter. Filter the results by the API version of the API request

organization_id str: organizationId path parameter. Organization ID
admin_id str: adminId query parameter. Filter the results by the ID of the admin who made the API requests
ending_before str: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
method str: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
operation_ids Sequence[str]: operationIds query parameter. Filter the results by one or more operation IDs for the API request
path str: path query parameter. Filter the results by the path of the API requests
per_page int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
response_code int: responseCode query parameter. Filter the results by the response code of the API requests
source_ip str: sourceIp query parameter. Filter the results by the IP address of the originating API request
starting_after str: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
t0 str: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 str: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan float: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
user_agent str: userAgent query parameter. Filter the results by the user agent string of the API request
version int: version query parameter. Filter the results by the API version of the API request

organizationId String: organizationId path parameter. Organization ID
adminId String: adminId query parameter. Filter the results by the ID of the admin who made the API requests
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
method String: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
operationIds List<String>: operationIds query parameter. Filter the results by one or more operation IDs for the API request
path String: path query parameter. Filter the results by the path of the API requests
perPage Number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
responseCode Number: responseCode query parameter. Filter the results by the response code of the API requests
sourceIp String: sourceIp query parameter. Filter the results by the IP address of the originating API request
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
t0 String: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 String: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan Number: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
userAgent String: userAgent query parameter. Filter the results by the user agent string of the API request
version Number: version query parameter. Filter the results by the API version of the API request

getApiRequests Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Items List<GetApiRequestsItem>: Array of ResponseOrganizationsGetOrganizationApiRequests
OrganizationId string: organizationId path parameter. Organization ID
AdminId string: adminId query parameter. Filter the results by the ID of the admin who made the API requests
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
Method string: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
OperationIds List<string>: operationIds query parameter. Filter the results by one or more operation IDs for the API request
Path string: path query parameter. Filter the results by the path of the API requests
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
ResponseCode int: responseCode query parameter. Filter the results by the response code of the API requests
SourceIp string: sourceIp query parameter. Filter the results by the IP address of the originating API request
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
T0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
T1 string: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
Timespan double: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
UserAgent string: userAgent query parameter. Filter the results by the user agent string of the API request
Version int: version query parameter. Filter the results by the API version of the API request

Id string: The provider-assigned unique ID for this managed resource.
Items []GetApiRequestsItem: Array of ResponseOrganizationsGetOrganizationApiRequests
OrganizationId string: organizationId path parameter. Organization ID
AdminId string: adminId query parameter. Filter the results by the ID of the admin who made the API requests
EndingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
Method string: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
OperationIds []string: operationIds query parameter. Filter the results by one or more operation IDs for the API request
Path string: path query parameter. Filter the results by the path of the API requests
PerPage int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
ResponseCode int: responseCode query parameter. Filter the results by the response code of the API requests
SourceIp string: sourceIp query parameter. Filter the results by the IP address of the originating API request
StartingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
T0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
T1 string: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
Timespan float64: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
UserAgent string: userAgent query parameter. Filter the results by the user agent string of the API request
Version int: version query parameter. Filter the results by the API version of the API request

id String: The provider-assigned unique ID for this managed resource.
items List<GetApiRequestsItem>: Array of ResponseOrganizationsGetOrganizationApiRequests
organizationId String: organizationId path parameter. Organization ID
adminId String: adminId query parameter. Filter the results by the ID of the admin who made the API requests
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
method String: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
operationIds List<String>: operationIds query parameter. Filter the results by one or more operation IDs for the API request
path String: path query parameter. Filter the results by the path of the API requests
perPage Integer: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
responseCode Integer: responseCode query parameter. Filter the results by the response code of the API requests
sourceIp String: sourceIp query parameter. Filter the results by the IP address of the originating API request
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
t0 String: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 String: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan Double: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
userAgent String: userAgent query parameter. Filter the results by the user agent string of the API request
version Integer: version query parameter. Filter the results by the API version of the API request

id string: The provider-assigned unique ID for this managed resource.
items GetApiRequestsItem[]: Array of ResponseOrganizationsGetOrganizationApiRequests
organizationId string: organizationId path parameter. Organization ID
adminId string: adminId query parameter. Filter the results by the ID of the admin who made the API requests
endingBefore string: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
method string: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
operationIds string[]: operationIds query parameter. Filter the results by one or more operation IDs for the API request
path string: path query parameter. Filter the results by the path of the API requests
perPage number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
responseCode number: responseCode query parameter. Filter the results by the response code of the API requests
sourceIp string: sourceIp query parameter. Filter the results by the IP address of the originating API request
startingAfter string: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
t0 string: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 string: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan number: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
userAgent string: userAgent query parameter. Filter the results by the user agent string of the API request
version number: version query parameter. Filter the results by the API version of the API request

id str: The provider-assigned unique ID for this managed resource.
items Sequence[GetApiRequestsItem]: Array of ResponseOrganizationsGetOrganizationApiRequests
organization_id str: organizationId path parameter. Organization ID
admin_id str: adminId query parameter. Filter the results by the ID of the admin who made the API requests
ending_before str: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
method str: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
operation_ids Sequence[str]: operationIds query parameter. Filter the results by one or more operation IDs for the API request
path str: path query parameter. Filter the results by the path of the API requests
per_page int: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
response_code int: responseCode query parameter. Filter the results by the response code of the API requests
source_ip str: sourceIp query parameter. Filter the results by the IP address of the originating API request
starting_after str: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
t0 str: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 str: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan float: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
user_agent str: userAgent query parameter. Filter the results by the user agent string of the API request
version int: version query parameter. Filter the results by the API version of the API request

id String: The provider-assigned unique ID for this managed resource.
items List<Property Map>: Array of ResponseOrganizationsGetOrganizationApiRequests
organizationId String: organizationId path parameter. Organization ID
adminId String: adminId query parameter. Filter the results by the ID of the admin who made the API requests
endingBefore String: endingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
method String: method query parameter. Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')
operationIds List<String>: operationIds query parameter. Filter the results by one or more operation IDs for the API request
path String: path query parameter. Filter the results by the path of the API requests
perPage Number: perPage query parameter. The number of entries per page returned. Acceptable range is 3 1000. Default is 50.
responseCode Number: responseCode query parameter. Filter the results by the response code of the API requests
sourceIp String: sourceIp query parameter. Filter the results by the IP address of the originating API request
startingAfter String: startingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
t0 String: t0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 31 days from today.
t1 String: t1 query parameter. The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan Number: timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days.
userAgent String: userAgent query parameter. Filter the results by the user agent string of the API request
version Number: version query parameter. Filter the results by the API version of the API request

Supporting Types

GetApiRequestsItem

AdminId string: Database ID for the admin user who made the API request.
Host string: The host which the API request was directed at.
Method string: HTTP method used in the API request.
OperationId string: Operation ID for the endpoint.
Path string: The API request path.
QueryString string: The query string sent with the API request.
ResponseCode int: API request response code.
SourceIp string: Public IP address from which the API request was made.
Ts string: Timestamp, in iso8601 format, indicating when the API request was made.
UserAgent string: The API request user agent.
Version int: API version of the endpoint.

AdminId string: Database ID for the admin user who made the API request.
Host string: The host which the API request was directed at.
Method string: HTTP method used in the API request.
OperationId string: Operation ID for the endpoint.
Path string: The API request path.
QueryString string: The query string sent with the API request.
ResponseCode int: API request response code.
SourceIp string: Public IP address from which the API request was made.
Ts string: Timestamp, in iso8601 format, indicating when the API request was made.
UserAgent string: The API request user agent.
Version int: API version of the endpoint.

adminId String: Database ID for the admin user who made the API request.
host String: The host which the API request was directed at.
method String: HTTP method used in the API request.
operationId String: Operation ID for the endpoint.
path String: The API request path.
queryString String: The query string sent with the API request.
responseCode Integer: API request response code.
sourceIp String: Public IP address from which the API request was made.
ts String: Timestamp, in iso8601 format, indicating when the API request was made.
userAgent String: The API request user agent.
version Integer: API version of the endpoint.

adminId string: Database ID for the admin user who made the API request.
host string: The host which the API request was directed at.
method string: HTTP method used in the API request.
operationId string: Operation ID for the endpoint.
path string: The API request path.
queryString string: The query string sent with the API request.
responseCode number: API request response code.
sourceIp string: Public IP address from which the API request was made.
ts string: Timestamp, in iso8601 format, indicating when the API request was made.
userAgent string: The API request user agent.
version number: API version of the endpoint.

admin_id str: Database ID for the admin user who made the API request.
host str: The host which the API request was directed at.
method str: HTTP method used in the API request.
operation_id str: Operation ID for the endpoint.
path str: The API request path.
query_string str: The query string sent with the API request.
response_code int: API request response code.
source_ip str: Public IP address from which the API request was made.
ts str: Timestamp, in iso8601 format, indicating when the API request was made.
user_agent str: The API request user agent.
version int: API version of the endpoint.

adminId String: Database ID for the admin user who made the API request.
host String: The host which the API request was directed at.
method String: HTTP method used in the API request.
operationId String: Operation ID for the endpoint.
path String: The API request path.
queryString String: The query string sent with the API request.
responseCode Number: API request response code.
sourceIp String: Public IP address from which the API request was made.
ts String: Timestamp, in iso8601 format, indicating when the API request was made.
userAgent String: The API request user agent.
version Number: API version of the endpoint.

Package Details

Repository: meraki pulumi/pulumi-meraki
License: Apache-2.0
Notes: This Pulumi package is based on the meraki Terraform Provider.

Cisco Meraki v0.2.10 published on Wednesday, Jul 24, 2024 by Pulumi

pulumi/pulumi-meraki

meraki.organizations.getApiRequests

On this page

On this page

Example Usage

Using getApiRequests

getApiRequests Result

Supporting Types

GetApiRequestsItem

Package Details

On this page

On this page