Deleting an API Access Rule

You can delete an API access rule that you no longer need.

However, you cannot delete the last remaining API access rule of your account.

Deleting an API Access Rule Using Cockpit v2

You cannot delete the last remaining API access rule of your account.

If you cannot access the APIs through the API access rules in place, you need to contact the Support team to regain access. For more information, see Technical Support.

  1. In the top right corner, click your initials.
    A drop-down menu appears.

  2. Click IconAAR API Access Rules.
    The list of your API access rules appears.

  3. Check the box of the API access rule you want to delete.

    Multiselection is available.

    The API access rule is selected and an action menu appears.

  4. Click IconTerminate Delete.
    A confirmation dialog box appears.

  5. Click Delete.
    The API access rule is deleted.

Deleting an API Access Rule Using OSC CLI

The DeleteApiAccessRule command deletes a specified API access rule.

You cannot delete the last remaining API access rule. However, if you delete all the API access rules that allow you to access the APIs, you need to contact the Support team to regain access. For more information, see Technical Support.
Request sample: Example with access key/secret key authentication
$ osc-cli api DeleteApiAccessRule --profile "default" \
    --ApiAccessRuleId "aar-1234567890abcdef1234567890abcdef"
Request sample: Example with login/password authentication
$ osc-cli api DeleteApiAccessRule --profile "default" --authentication-method "password" --login "$OSC_EMAIL" --password "$OSC_PASSWORD" \
    --ApiAccessRuleId "aar-1234567890abcdef1234567890abcdef"

This command contains the following attributes that you need to specify:

  • ApiAccessRuleId: The ID of the API access rule you want to delete.

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

The DeleteApiAccessRule command returns the following elements:

  • ResponseContext: Information about the context of the response.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  }
}

Related Pages

Corresponding API Method

Export to PDF