Skip to content
Primary navigation

Delete admin API key

AdminApiKeyDeleteResponse admin().organization().adminApiKeys().delete(AdminApiKeyDeleteParamsparams = AdminApiKeyDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/organization/admin_api_keys/{key_id}

Delete an organization admin API key

ParametersExpand Collapse
AdminApiKeyDeleteParams params
Optional<String> keyId

The ID of the API key to be deleted.

ReturnsExpand Collapse
class AdminApiKeyDeleteResponse:
String id
boolean deleted
JsonValue; object_ "organization.admin_api_key.deleted"constant"organization.admin_api_key.deleted"constant

Delete admin API key

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.admin.organization.adminapikeys.AdminApiKeyDeleteParams;
import com.openai.models.admin.organization.adminapikeys.AdminApiKeyDeleteResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        AdminApiKeyDeleteResponse adminApiKey = client.admin().organization().adminApiKeys().delete("key_id");
    }
}
{
  "id": "key_abc",
  "object": "organization.admin_api_key.deleted",
  "deleted": true
}
Returns Examples
{
  "id": "key_abc",
  "object": "organization.admin_api_key.deleted",
  "deleted": true
}