ip-profile get

read onlyrepeatable

One profile: the networks it allows and the applications it is attached to.

An attached profile with no rules leaves its application reachable from nowhere. That is a working configuration and almost never the intended one.

Usage

outplane ip-profile get <PROFILE>

Arguments

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

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

Show a profile

outplane ip-profile get office

Read the networks in a pipeline

outplane ip-profile get office --json --fields ruleList

{
  "ruleList": [
    {
      "cidr": "203.0.113.0/24",
      "description": "office"
    }
  ]
}

See which applications a change would affect

outplane ip-profile get office --json --fields assignedApps

What to Know

The id inside assignedApps is the assignment's own id, not the application's. It is what the platform removes an attachment by, and ip-profile unassign looks it up rather than asking for it.
An empty ruleList on an attached profile means the application is reachable from nowhere, which is a working configuration and almost never the intended one.
Two requests, not one: the API addresses profiles by id, so a name has to be resolved against the list first.

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.
`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, usage.missing_argument, context.no_team. Branch on that, or on the exit status. The message is prose and changes.