ip-profile delete

destructiverepeatable--dry-run

Deletes a profile.

The platform refuses while anything still uses it, so ip-profile unassign has to run first. ip-profile get lists what is still attached.

Usage

outplane ip-profile delete <PROFILE> [flags]

Arguments

Argument	Type	Description
`PROFILE`	`string`	Profile name or id. Required.

Flag	Type	Description
`-y`, `--yes`	`bool`	Acknowledge the deletion. Not sufficient on its own.
`--confirm-name`	`string`	The profile's name, repeated. Guards against deleting the wrong one.

Output

Field	Type	Description
`id`	`string`
`name`	`string`
`description`	`string \| null`
`rules`	`int`	How many networks it allows.
`assignments`	`int`	How many applications use it.
`ruleList`	`array`	The networks themselves, {cidr, description}. Sorted, and JSON only.
`assignedApps`	`array`	The applications using it, {id, app, appId}. id is the assignment's own id, which is what detaching needs.
`createdAt`	`string \| null`	RFC 3339, UTC.
`changed`	`bool`	False for a dry run.

Examples

Check what would go, and what still uses it

outplane ip-profile delete office --dry-run --json

{
  "assignments": 0,
  "changed": false,
  "name": "office",
  "rules": 2
}

Request deletion. Returns exit 4 with a command to replay

outplane ip-profile delete office

The confirmed form

outplane ip-profile delete office --yes --confirm-name office

What to Know

The platform refuses while the profile is assigned to anything, with its own message. That is the server's rule and this command does not predict it; ip-profile get lists what still uses it.
Refused under an agent harness, exit 4 with confirmation.required, whatever flags are given.
Outside a harness, both --yes and --confirm-name are required and the name has to match exactly.

Errors

Beyond 0 for success, this command exits with:

Exit	Kind	Meaning
`2`	`usage`	Invalid arguments, unknown flag, or client-side validation failure.
`3`	`auth`	Not authenticated, token revoked or expired, or forbidden for this team.
`4`	`confirmation_required`	A destructive operation stopped. Replay the command in confirm_command.
`5`	`not_found`	The named resource does not exist, or is not visible to this credential.
`8`	`upstream`	The Out Plane API returned a server error.

The code on the error object is one of ipprofile.not_found, ipprofile.confirm_name_mismatch, confirmation.required, usage.missing_argument, context.no_team. Branch on that, or on the exit status. The message is prose and changes.