---
title: Create Temporary Access Credentials
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/typescript)

[R2](https://developers.cloudflare.com/api/typescript/resources/r2)

[Temporary Credentials](https://developers.cloudflare.com/api/typescript/resources/r2/subresources/temporary_credentials)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Create Temporary Access Credentials

client.r2.temporaryCredentials.create(TemporaryCredentialCreateParams {account\_id, bucket, parentAccessKeyId, 4 more } params, RequestOptionsoptions?): [TemporaryCredentialCreateResponse](<https://developers.cloudflare.com/api/typescript/resources/r2#(resource)%20r2.temporary_credentials%20%3E%20(model)%20temporary_credential_create_response%20%3E%20(schema)>) {accessKeyId, secretAccessKey, sessionToken }

POST/accounts/{account\_id}/r2/temp-access-credentials

Creates temporary access credentials on a bucket that can be optionally scoped to prefixes or objects.

##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/).

**Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY`

##### ParametersExpand Collapse

<details>

<summary>

params: TemporaryCredentialCreateParams {account\_id, bucket, parentAccessKeyId, 4 more }

</summary>

account\_id: string

Path param: Cloudflare account ID that owns the R2 resource.

maxLength32

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20account_id">Link to this property</a>

bucket: string

Body param: Name of the R2 bucket.

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20bucket">Link to this property</a>

parentAccessKeyId: string

Body param: Access key ID of the parent R2 API token. The temporary credentials cannot exceed this token’s permissions.

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20parentAccessKeyId">Link to this property</a>

<details>

<summary>

permission: "admin-read-write"| "admin-read-only"| "object-read-write"| "object-read-only"

Body param: Permissions allowed on the credentials.

</summary>

One of the following:

"admin-read-write"

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20permission%20%3E%20(schema)%20%3E%20(member)%200">Link to this property</a>

"admin-read-only"

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20permission%20%3E%20(schema)%20%3E%20(member)%201">Link to this property</a>

"object-read-write"

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20permission%20%3E%20(schema)%20%3E%20(member)%202">Link to this property</a>

"object-read-only"

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20permission%20%3E%20(schema)%20%3E%20(member)%203">Link to this property</a>

</details>

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20permission">Link to this property</a>

ttlSeconds: number

Body param: Lifetime of the temporary credentials in seconds, up to 604800 seconds (7 days).

maximum604800

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20ttlSeconds">Link to this property</a>

objects?: Array&lt;string&gt;

Body param: Optional object paths to scope the credentials to.

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20objects">Link to this property</a>

prefixes?: Array&lt;string&gt;

Body param: Optional prefix paths to scope the credentials to.

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20prefixes">Link to this property</a>

</details>

[Link to this property](<#(resource)%20r2.temporary_credentials%20%3E%20(method)%20create%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

TemporaryCredentialCreateResponse {accessKeyId, secretAccessKey, sessionToken }

</summary>

accessKeyId?: string

ID for new access key.

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(model)%20temporary_credential_create_response%20%3E%20(schema)%20%3E%20(property)%20accessKeyId">Link to this property</a>

secretAccessKey?: string

Secret access key.

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(model)%20temporary_credential_create_response%20%3E%20(schema)%20%3E%20(property)%20secretAccessKey">Link to this property</a>

sessionToken?: string

Security token.

<a href="#(resource)%20r2.temporary_credentials%20%3E%20(model)%20temporary_credential_create_response%20%3E%20(schema)%20%3E%20(property)%20sessionToken">Link to this property</a>

</details>

[Link to this property](<#(resource)%20r2.temporary_credentials%20%3E%20(model)%20temporary_credential_create_response%20%3E%20(schema)>)

### Create Temporary Access Credentials

TypeScript

HTTPTypeScriptPythonGoTerraform

```
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const temporaryCredential = await client.r2.temporaryCredentials.create({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  bucket: 'example-bucket',
  parentAccessKeyId: 'example-access-key-id',
  permission: 'object-read-write',
  ttlSeconds: 3600,
});

console.log(temporaryCredential.accessKeyId);
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "accessKeyId": "example-access-key-id",
    "secretAccessKey": "example-secret-key",
    "sessionToken": "example-session-token"
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    "string"
  ],
  "result": {
    "accessKeyId": "example-access-key-id",
    "secretAccessKey": "example-secret-key",
    "sessionToken": "example-session-token"
  },
  "success": true
}
```