Update API key - Openlayer

Python

from openlayer import Openlayer

client = Openlayer()

api_key = client.workspaces.api_keys.update(
    "3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b",
    workspace_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    name="CI pipeline (prod)",
)
print(api_key.name)

import Openlayer from 'openlayer';

const client = new Openlayer();

const apiKey = await client.workspaces.apiKeys.update('3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b', {
  workspaceId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  name: 'CI pipeline (prod)',
});

console.log(apiKey.name);

package main

import (
	"context"
	"fmt"

	"github.com/openlayer-ai/openlayer-go"
)

client := openlayer.NewClient()
apiKey, err := client.Workspaces.APIKeys.Update(
	context.TODO(),
	"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
	"3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b",
	openlayer.WorkspaceAPIKeyUpdateParams{
		Name: openlayer.F("CI pipeline (prod)"),
	},
)
if err != nil {
	panic(err.Error())
}
fmt.Printf("%+v\n", apiKey.Name)

import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
import com.openlayer.api.models.workspaces.apikeys.ApiKeyUpdateParams;
import com.openlayer.api.models.workspaces.apikeys.ApiKeyUpdateResponse;

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();

ApiKeyUpdateParams params = ApiKeyUpdateParams.builder()
    .workspaceId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .apiKeyId("3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b")
    .name("CI pipeline key (prod)")
    .build();
ApiKeyUpdateResponse apiKey = client.workspaces().apiKeys().update(params);

require "openlayer"

openlayer = Openlayer::Client.new(api_key: ENV["OPENLAYER_API_KEY"])

api_key = openlayer.workspaces.api_keys.update(
  "3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b",
  workspace_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  name: "Production key"
)

puts(api_key)

curl --request PUT \
  --url https://api.openlayer.com/v1/workspaces/182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e/api-keys/3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b \
  --header 'Authorization: Bearer <token>' \
  --data '{"name": "Production ingest"}'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "dateLastUsed": "2023-11-07T05:31:56Z",
  "secureKey": "sk-o...5PW0",
  "status": "active",
  "name": "Secret Key",
  "secret": "sk-ol-Xq3v9Rk2mPz8TnW4yL7bC1dF5hJ6",
  "expiresAt": "2027-01-01T00:00:00Z",
  "lastRotatedAt": "2023-11-07T05:31:56Z",
  "previousKeyExpiresAt": "2023-11-07T05:31:56Z"
}

Python

from openlayer import Openlayer

client = Openlayer()

api_key = client.workspaces.api_keys.update(
    "3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b",
    workspace_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    name="CI pipeline (prod)",
)
print(api_key.name)

import Openlayer from 'openlayer';

const client = new Openlayer();

const apiKey = await client.workspaces.apiKeys.update('3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b', {
  workspaceId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  name: 'CI pipeline (prod)',
});

console.log(apiKey.name);

package main

import (
	"context"
	"fmt"

	"github.com/openlayer-ai/openlayer-go"
)

client := openlayer.NewClient()
apiKey, err := client.Workspaces.APIKeys.Update(
	context.TODO(),
	"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
	"3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b",
	openlayer.WorkspaceAPIKeyUpdateParams{
		Name: openlayer.F("CI pipeline (prod)"),
	},
)
if err != nil {
	panic(err.Error())
}
fmt.Printf("%+v\n", apiKey.Name)

import com.openlayer.api.client.OpenlayerClient;
import com.openlayer.api.client.okhttp.OpenlayerOkHttpClient;
import com.openlayer.api.models.workspaces.apikeys.ApiKeyUpdateParams;
import com.openlayer.api.models.workspaces.apikeys.ApiKeyUpdateResponse;

OpenlayerClient client = OpenlayerOkHttpClient.fromEnv();

ApiKeyUpdateParams params = ApiKeyUpdateParams.builder()
    .workspaceId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
    .apiKeyId("3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b")
    .name("CI pipeline key (prod)")
    .build();
ApiKeyUpdateResponse apiKey = client.workspaces().apiKeys().update(params);

require "openlayer"

openlayer = Openlayer::Client.new(api_key: ENV["OPENLAYER_API_KEY"])

api_key = openlayer.workspaces.api_keys.update(
  "3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b",
  workspace_id: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  name: "Production key"
)

puts(api_key)

curl --request PUT \
  --url https://api.openlayer.com/v1/workspaces/182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e/api-keys/3f2b9c1e-8a4d-4e6f-9b7a-1c2d3e4f5a6b \
  --header 'Authorization: Bearer <token>' \
  --data '{"name": "Production ingest"}'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dateCreated": "2023-11-07T05:31:56Z",
  "dateUpdated": "2023-11-07T05:31:56Z",
  "dateLastUsed": "2023-11-07T05:31:56Z",
  "secureKey": "sk-o...5PW0",
  "status": "active",
  "name": "Secret Key",
  "secret": "sk-ol-Xq3v9Rk2mPz8TnW4yL7bC1dF5hJ6",
  "expiresAt": "2027-01-01T00:00:00Z",
  "lastRotatedAt": "2023-11-07T05:31:56Z",
  "previousKeyExpiresAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

workspaceId

string<uuid>

required

The workspace id.

apiKeyId

string<uuid>

required

The API key id.

Body

application/json

name

any

Response

200 - application/json

Status OK.

id

string<uuid>

required

read-only

The API key id.

dateCreated

string<date-time>

required

read-only

The API key creation date.

dateUpdated

string<date-time>

required

read-only

The API key last update date.

dateLastUsed

string<date-time> | null

required

read-only

The API key last use date.

secureKey

string

required

read-only

An obfuscated hint of the API key value. When a key is created or rotated this also holds the full secret, for backward compatibility; prefer secret.

Maximum string length: 120

Example:

"sk-o...5PW0"

status

enum<string>

required

read-only

The key's lifecycle state. active: the current secret authenticates. rotating: the key was rotated and the previous secret still authenticates until previousKeyExpiresAt. expired: expiresAt has passed, no secret authenticates, and the key can't be rotated.

Available options:

active,

rotating,

expired

Example:

"active"

name

string | null

The API key name.

Maximum string length: 120

Example:

"Secret Key"

secret

string

read-only

The full API key. Only present in the response that creates or rotates the key, and never shown again.

Example:

"sk-ol-Xq3v9Rk2mPz8TnW4yL7bC1dF5hJ6"

expiresAt

string<date-time> | null

When the key stops authenticating. null means the key never expires. Set when the key is created or rotated, and must be in the future. When the request is authenticated with an API key that expires, the result can't be later than that key's expiry. On create, omit it to inherit that expiry. On rotate, omit it to keep the current one. It can't be changed with an update; rotate the key instead.

Example:

"2027-01-01T00:00:00Z"

lastRotatedAt

string<date-time> | null

read-only

When the key was last rotated.

previousKeyExpiresAt

string<date-time> | null

read-only

While status is rotating, when the previous secret stops authenticating.