1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getApiTokens
Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi

cloudflare.getApiTokens

Explore with Pulumi AI

Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi

Example Usage

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

const exampleApiTokens = cloudflare.getApiTokens({
    direction: "desc",
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example_api_tokens = cloudflare.get_api_tokens(direction="desc")
Copy
package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupApiTokens(ctx, &cloudflare.LookupApiTokensArgs{
			Direction: pulumi.StringRef("desc"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleApiTokens = Cloudflare.GetApiTokens.Invoke(new()
    {
        Direction = "desc",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetApiTokensArgs;
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 exampleApiTokens = CloudflareFunctions.getApiTokens(GetApiTokensArgs.builder()
            .direction("desc")
            .build());

    }
}
Copy
variables:
  exampleApiTokens:
    fn::invoke:
      function: cloudflare:getApiTokens
      arguments:
        direction: desc
Copy

Using getApiTokens

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 getApiTokens(args: GetApiTokensArgs, opts?: InvokeOptions): Promise<GetApiTokensResult>
function getApiTokensOutput(args: GetApiTokensOutputArgs, opts?: InvokeOptions): Output<GetApiTokensResult>
Copy
def get_api_tokens(direction: Optional[str] = None,
                   max_items: Optional[int] = None,
                   opts: Optional[InvokeOptions] = None) -> GetApiTokensResult
def get_api_tokens_output(direction: Optional[pulumi.Input[str]] = None,
                   max_items: Optional[pulumi.Input[int]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetApiTokensResult]
Copy
func LookupApiTokens(ctx *Context, args *LookupApiTokensArgs, opts ...InvokeOption) (*LookupApiTokensResult, error)
func LookupApiTokensOutput(ctx *Context, args *LookupApiTokensOutputArgs, opts ...InvokeOption) LookupApiTokensResultOutput
Copy

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

public static class GetApiTokens 
{
    public static Task<GetApiTokensResult> InvokeAsync(GetApiTokensArgs args, InvokeOptions? opts = null)
    public static Output<GetApiTokensResult> Invoke(GetApiTokensInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApiTokensResult> getApiTokens(GetApiTokensArgs args, InvokeOptions options)
public static Output<GetApiTokensResult> getApiTokens(GetApiTokensArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: cloudflare:index/getApiTokens:getApiTokens
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Direction string
Direction to order results. Available values: "asc", "desc".
MaxItems int
Max items to fetch, default: 1000
Direction string
Direction to order results. Available values: "asc", "desc".
MaxItems int
Max items to fetch, default: 1000
direction String
Direction to order results. Available values: "asc", "desc".
maxItems Integer
Max items to fetch, default: 1000
direction string
Direction to order results. Available values: "asc", "desc".
maxItems number
Max items to fetch, default: 1000
direction str
Direction to order results. Available values: "asc", "desc".
max_items int
Max items to fetch, default: 1000
direction String
Direction to order results. Available values: "asc", "desc".
maxItems Number
Max items to fetch, default: 1000

getApiTokens Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Results List<GetApiTokensResult>
The items returned by the data source
Direction string
Direction to order results. Available values: "asc", "desc".
MaxItems int
Max items to fetch, default: 1000
Id string
The provider-assigned unique ID for this managed resource.
Results []GetApiTokensResult
The items returned by the data source
Direction string
Direction to order results. Available values: "asc", "desc".
MaxItems int
Max items to fetch, default: 1000
id String
The provider-assigned unique ID for this managed resource.
results List<GetApiTokensResult>
The items returned by the data source
direction String
Direction to order results. Available values: "asc", "desc".
maxItems Integer
Max items to fetch, default: 1000
id string
The provider-assigned unique ID for this managed resource.
results GetApiTokensResult[]
The items returned by the data source
direction string
Direction to order results. Available values: "asc", "desc".
maxItems number
Max items to fetch, default: 1000
id str
The provider-assigned unique ID for this managed resource.
results Sequence[GetApiTokensResult]
The items returned by the data source
direction str
Direction to order results. Available values: "asc", "desc".
max_items int
Max items to fetch, default: 1000
id String
The provider-assigned unique ID for this managed resource.
results List<Property Map>
The items returned by the data source
direction String
Direction to order results. Available values: "asc", "desc".
maxItems Number
Max items to fetch, default: 1000

Supporting Types

GetApiTokensResult

Condition This property is required. GetApiTokensResultCondition
ExpiresOn This property is required. string
The expiration time on or after which the JWT MUST NOT be accepted for processing.
Id This property is required. string
Token identifier tag.
IssuedOn This property is required. string
The time on which the token was created.
LastUsedOn This property is required. string
Last time the token was used.
ModifiedOn This property is required. string
Last time the token was modified.
Name This property is required. string
Token name.
NotBefore This property is required. string
The time before which the token MUST NOT be accepted for processing.
Policies This property is required. List<GetApiTokensResultPolicy>
List of access policies assigned to the token.
Status This property is required. string
Status of the token. Available values: "active", "disabled", "expired".
Condition This property is required. GetApiTokensResultCondition
ExpiresOn This property is required. string
The expiration time on or after which the JWT MUST NOT be accepted for processing.
Id This property is required. string
Token identifier tag.
IssuedOn This property is required. string
The time on which the token was created.
LastUsedOn This property is required. string
Last time the token was used.
ModifiedOn This property is required. string
Last time the token was modified.
Name This property is required. string
Token name.
NotBefore This property is required. string
The time before which the token MUST NOT be accepted for processing.
Policies This property is required. []GetApiTokensResultPolicy
List of access policies assigned to the token.
Status This property is required. string
Status of the token. Available values: "active", "disabled", "expired".
condition This property is required. GetApiTokensResultCondition
expiresOn This property is required. String
The expiration time on or after which the JWT MUST NOT be accepted for processing.
id This property is required. String
Token identifier tag.
issuedOn This property is required. String
The time on which the token was created.
lastUsedOn This property is required. String
Last time the token was used.
modifiedOn This property is required. String
Last time the token was modified.
name This property is required. String
Token name.
notBefore This property is required. String
The time before which the token MUST NOT be accepted for processing.
policies This property is required. List<GetApiTokensResultPolicy>
List of access policies assigned to the token.
status This property is required. String
Status of the token. Available values: "active", "disabled", "expired".
condition This property is required. GetApiTokensResultCondition
expiresOn This property is required. string
The expiration time on or after which the JWT MUST NOT be accepted for processing.
id This property is required. string
Token identifier tag.
issuedOn This property is required. string
The time on which the token was created.
lastUsedOn This property is required. string
Last time the token was used.
modifiedOn This property is required. string
Last time the token was modified.
name This property is required. string
Token name.
notBefore This property is required. string
The time before which the token MUST NOT be accepted for processing.
policies This property is required. GetApiTokensResultPolicy[]
List of access policies assigned to the token.
status This property is required. string
Status of the token. Available values: "active", "disabled", "expired".
condition This property is required. GetApiTokensResultCondition
expires_on This property is required. str
The expiration time on or after which the JWT MUST NOT be accepted for processing.
id This property is required. str
Token identifier tag.
issued_on This property is required. str
The time on which the token was created.
last_used_on This property is required. str
Last time the token was used.
modified_on This property is required. str
Last time the token was modified.
name This property is required. str
Token name.
not_before This property is required. str
The time before which the token MUST NOT be accepted for processing.
policies This property is required. Sequence[GetApiTokensResultPolicy]
List of access policies assigned to the token.
status This property is required. str
Status of the token. Available values: "active", "disabled", "expired".
condition This property is required. Property Map
expiresOn This property is required. String
The expiration time on or after which the JWT MUST NOT be accepted for processing.
id This property is required. String
Token identifier tag.
issuedOn This property is required. String
The time on which the token was created.
lastUsedOn This property is required. String
Last time the token was used.
modifiedOn This property is required. String
Last time the token was modified.
name This property is required. String
Token name.
notBefore This property is required. String
The time before which the token MUST NOT be accepted for processing.
policies This property is required. List<Property Map>
List of access policies assigned to the token.
status This property is required. String
Status of the token. Available values: "active", "disabled", "expired".

GetApiTokensResultCondition

RequestIp This property is required. GetApiTokensResultConditionRequestIp
Client IP restrictions.
RequestIp This property is required. GetApiTokensResultConditionRequestIp
Client IP restrictions.
requestIp This property is required. GetApiTokensResultConditionRequestIp
Client IP restrictions.
requestIp This property is required. GetApiTokensResultConditionRequestIp
Client IP restrictions.
request_ip This property is required. GetApiTokensResultConditionRequestIp
Client IP restrictions.
requestIp This property is required. Property Map
Client IP restrictions.

GetApiTokensResultConditionRequestIp

Ins This property is required. List<string>
List of IPv4/IPv6 CIDR addresses.
NotIns This property is required. List<string>
List of IPv4/IPv6 CIDR addresses.
Ins This property is required. []string
List of IPv4/IPv6 CIDR addresses.
NotIns This property is required. []string
List of IPv4/IPv6 CIDR addresses.
ins This property is required. List<String>
List of IPv4/IPv6 CIDR addresses.
notIns This property is required. List<String>
List of IPv4/IPv6 CIDR addresses.
ins This property is required. string[]
List of IPv4/IPv6 CIDR addresses.
notIns This property is required. string[]
List of IPv4/IPv6 CIDR addresses.
ins This property is required. Sequence[str]
List of IPv4/IPv6 CIDR addresses.
not_ins This property is required. Sequence[str]
List of IPv4/IPv6 CIDR addresses.
ins This property is required. List<String>
List of IPv4/IPv6 CIDR addresses.
notIns This property is required. List<String>
List of IPv4/IPv6 CIDR addresses.

GetApiTokensResultPolicy

Effect This property is required. string
Allow or deny operations against the resources. Available values: "allow", "deny".
Id This property is required. string
Policy identifier.
PermissionGroups This property is required. List<GetApiTokensResultPolicyPermissionGroup>
A set of permission groups that are specified to the policy.
Resources This property is required. Dictionary<string, string>
A list of resource names that the policy applies to.
Effect This property is required. string
Allow or deny operations against the resources. Available values: "allow", "deny".
Id This property is required. string
Policy identifier.
PermissionGroups This property is required. []GetApiTokensResultPolicyPermissionGroup
A set of permission groups that are specified to the policy.
Resources This property is required. map[string]string
A list of resource names that the policy applies to.
effect This property is required. String
Allow or deny operations against the resources. Available values: "allow", "deny".
id This property is required. String
Policy identifier.
permissionGroups This property is required. List<GetApiTokensResultPolicyPermissionGroup>
A set of permission groups that are specified to the policy.
resources This property is required. Map<String,String>
A list of resource names that the policy applies to.
effect This property is required. string
Allow or deny operations against the resources. Available values: "allow", "deny".
id This property is required. string
Policy identifier.
permissionGroups This property is required. GetApiTokensResultPolicyPermissionGroup[]
A set of permission groups that are specified to the policy.
resources This property is required. {[key: string]: string}
A list of resource names that the policy applies to.
effect This property is required. str
Allow or deny operations against the resources. Available values: "allow", "deny".
id This property is required. str
Policy identifier.
permission_groups This property is required. Sequence[GetApiTokensResultPolicyPermissionGroup]
A set of permission groups that are specified to the policy.
resources This property is required. Mapping[str, str]
A list of resource names that the policy applies to.
effect This property is required. String
Allow or deny operations against the resources. Available values: "allow", "deny".
id This property is required. String
Policy identifier.
permissionGroups This property is required. List<Property Map>
A set of permission groups that are specified to the policy.
resources This property is required. Map<String>
A list of resource names that the policy applies to.

GetApiTokensResultPolicyPermissionGroup

Id This property is required. string
Identifier of the group.
Meta This property is required. GetApiTokensResultPolicyPermissionGroupMeta
Attributes associated to the permission group.
Name This property is required. string
Name of the group.
Id This property is required. string
Identifier of the group.
Meta This property is required. GetApiTokensResultPolicyPermissionGroupMeta
Attributes associated to the permission group.
Name This property is required. string
Name of the group.
id This property is required. String
Identifier of the group.
meta This property is required. GetApiTokensResultPolicyPermissionGroupMeta
Attributes associated to the permission group.
name This property is required. String
Name of the group.
id This property is required. string
Identifier of the group.
meta This property is required. GetApiTokensResultPolicyPermissionGroupMeta
Attributes associated to the permission group.
name This property is required. string
Name of the group.
id This property is required. str
Identifier of the group.
meta This property is required. GetApiTokensResultPolicyPermissionGroupMeta
Attributes associated to the permission group.
name This property is required. str
Name of the group.
id This property is required. String
Identifier of the group.
meta This property is required. Property Map
Attributes associated to the permission group.
name This property is required. String
Name of the group.

GetApiTokensResultPolicyPermissionGroupMeta

Key This property is required. string
Value This property is required. string
Key This property is required. string
Value This property is required. string
key This property is required. String
value This property is required. String
key This property is required. string
value This property is required. string
key This property is required. str
value This property is required. str
key This property is required. String
value This property is required. String

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.
Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi