Out Plane
ip-profile

ip-profile list

List the team's IP access profiles.

read onlyrepeatable

The team's profiles, with how many rules each holds and how many applications use it.

An empty list means no application in this team restricts who can reach it.

Usage

outplane ip-profile list

Output

FieldTypeDescription
idstring
namestring
descriptionstring | null
rulesintHow many networks it allows.
assignmentsintHow many applications use it.
ruleListarrayThe networks themselves, {cidr, description}. Sorted, and JSON only.
assignedAppsarrayThe applications using it, {id, app, appId}. id is the assignment's own id, which is what detaching needs.
createdAtstring | nullRFC 3339, UTC.
changedboolFalse for a dry run.

Examples

What this team has

outplane ip-profile list

Find the ones nothing uses

outplane ip-profile list --json --fields name,assignments
{
  "items": [
    {
      "assignments": 2,
      "name": "office"
    }
  ],
  "total": 1,
  "truncated": false
}

Read it as a table

outplane ip-profile list -o text

What to Know

  • The list carries counts rather than the rules themselves. ip-profile get returns the networks and the applications using them.
  • An empty list means no application in this team restricts who can reach it.
  • Every rule allows. The platform declares a deny mode and does not implement it, so a profile can only ever narrow what reaches an application.

Errors

Beyond 0 for success, this command exits with:

ExitKindMeaning
2usageInvalid arguments, unknown flag, or client-side validation failure.
3authNot authenticated, token revoked or expired, or forbidden for this team.
8upstreamThe Out Plane API returned a server error.

The code on the error object is one of context.no_team. Branch on that, or on the exit status. The message is prose and changes.

On this page