# Models

## The api\_key object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"api_key":{"type":"object","title":"API key Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"is_of__actor":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"},"description":{"description":"Type information not available yet"}}}}}}
```

## The device object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"device":{"type":"object","title":"Device Model","properties":{"id":{"description":"Type information not available yet"},"belongs_to__application":{"description":"Type information not available yet"},"belongs_to__user":{"description":"Type information not available yet"},"actor":{"description":"Type information not available yet"},"device_name":{"description":"Type information not available yet"},"is_of__device_type":{"description":"Type information not available yet"},"uuid":{"description":"Type information not available yet"},"is_running__release":{"description":"Type information not available yet"},"is_pinned_on__release":{"description":"Type information not available yet"},"should_be_running__release":{"description":"Type information not available yet"},"note":{"description":"Type information not available yet"},"local_id":{"description":"Type information not available yet"},"status":{"description":"Type information not available yet"},"overall_status":{"description":"Type information not available yet"},"is_online":{"description":"Type information not available yet"},"last_connectivity_event":{"description":"Type information not available yet"},"is_connected_to_vpn":{"description":"Type information not available yet"},"last_vpn_event":{"description":"Type information not available yet"},"ip_address":{"description":"Type information not available yet"},"mac_address":{"description":"Type information not available yet"},"public_address":{"description":"Type information not available yet"},"os_version":{"description":"Type information not available yet"},"os_variant":{"description":"Type information not available yet"},"supervisor_version":{"description":"Type information not available yet"},"should_be_managed_by__release":{"description":"Type information not available yet"},"is_managed_by__service_instance":{"description":"Type information not available yet"},"provisioning_progress":{"description":"Type information not available yet"},"provisioning_state":{"description":"Type information not available yet"},"download_progress":{"description":"Type information not available yet"},"is_web_accessible":{"description":"Type information not available yet"},"longitude":{"description":"Type information not available yet"},"latitude":{"description":"Type information not available yet"},"location":{"description":"Type information not available yet"},"custom_longitude":{"description":"Type information not available yet"},"custom_latitude":{"description":"Type information not available yet"},"is_locked_until__date":{"description":"Type information not available yet"},"is_accessible_by_support_until__date":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"is_active":{"description":"Type information not available yet"},"api_heartbeat_state":{"description":"Type information not available yet"},"memory_usage":{"description":"Type information not available yet"},"memory_total":{"description":"Type information not available yet"},"storage_block_device":{"description":"Type information not available yet"},"storage_usage":{"description":"Type information not available yet"},"storage_total":{"description":"Type information not available yet"},"cpu_temp":{"description":"Type information not available yet"},"cpu_usage":{"description":"Type information not available yet"},"cpu_id":{"description":"Type information not available yet"},"is_undervolted":{"description":"Type information not available yet"}}}}}}
```

## The device\_config\_variable object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"device_config_variable":{"type":"object","title":"Device config variable Model","properties":{"id":{"description":"Type information not available yet"},"device":{"description":"Type information not available yet"},"value":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"}}}}}}
```

## The device\_environment\_variable object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"device_environment_variable":{"type":"object","title":"Device Environment Variable Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"device":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"},"value":{"description":"Type information not available yet"}}}}}}
```

## The device\_service\_environment\_variable object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"device_service_environment_variable":{"type":"object","title":"Device service variable Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"service_install":{"description":"Type information not available yet"},"value":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"}}}}}}
```

## The device\_tag object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"device_tag":{"type":"object","title":"Device tag Model","properties":{"id":{"description":"Type information not available yet"},"device":{"description":"Type information not available yet"},"tag_key":{"description":"Type information not available yet"},"value":{"description":"Type information not available yet"}}}}}}
```

## The device\_type object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"device_type":{"type":"object","title":"Device type Model","properties":{"id":{"description":"Type information not available yet"},"slug":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"},"is_private":{"description":"Type information not available yet"},"is_of__cpu_architecture":{"description":"Type information not available yet"},"belongs_to__device_family":{"description":"Type information not available yet"}}}}}}
```

## The fleet object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"fleet":{"type":"object","title":"Fleet Model","properties":{"id":{"description":"Type information not available yet"},"uuid":{"description":"Type information not available yet"},"organization":{"description":"Type information not available yet"},"actor":{"description":"Type information not available yet"},"app_name":{"description":"Type information not available yet"},"slug":{"description":"Type information not available yet"},"should_be_running__release":{"description":"Type information not available yet"},"application_type":{"description":"Type information not available yet"},"is_for__device_type":{"description":"Type information not available yet"},"should_track_latest_release":{"description":"Type information not available yet"},"is_accessible_by_support_until__date":{"description":"Type information not available yet"},"is_public":{"description":"Type information not available yet"},"is_host":{"description":"Type information not available yet"},"is_archived":{"description":"Type information not available yet"},"is_discoverable":{"description":"Type information not available yet"},"is_stored_at__repository_url":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"}}}}}}
```

## The fleet\_config\_variable object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"fleet_config_variable":{"type":"object","title":"Fleet config variable Model","properties":{"id":{"description":"Type information not available yet"},"application":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"},"value":{"description":"Type information not available yet"}}}}}}
```

## The fleet\_environment\_variable object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"fleet_environment_variable":{"type":"object","title":"Fleet environment variable Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"application":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"},"value":{"description":"Type information not available yet"}}}}}}
```

## The fleet\_membership\_role object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"fleet_membership_role":{"type":"object","title":"Fleet membership role Model","properties":{"id":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"}}}}}}
```

## The service\_environment\_variable object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"service_environment_variable":{"type":"object","title":"Fleet service variable Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"service_install":{"description":"Type information not available yet"},"value":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"}}}}}}
```

## The fleet\_tag object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"fleet_tag":{"type":"object","title":"Fleet tag Model","properties":{"id":{"description":"Type information not available yet"},"application":{"description":"Type information not available yet"},"tag_key":{"description":"Type information not available yet"},"value":{"description":"Type information not available yet"}}}}}}
```

## The supervisor\_release object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"supervisor_release":{"type":"object","title":"List Supervisor releases Model","properties":{"id":{"description":"Type information not available yet"},"raw_version":{"description":"Type information not available yet"}}}}}}
```

## The organization object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"organization":{"type":"object","title":"Organization Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"},"handle":{"description":"Type information not available yet"},"company_name":{"description":"Type information not available yet"},"website":{"description":"Type information not available yet"},"industry":{"description":"Type information not available yet"},"billing_account_code":{"description":"Type information not available yet"}}}}}}
```

## The organization\_membership object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"organization_membership":{"type":"object","title":"Organization Membership Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"user":{"description":"Type information not available yet"},"is_member_of__organization":{"description":"Type information not available yet"},"organization_membership_role":{"description":"Type information not available yet"},"effective_seat_role":{"description":"Type information not available yet"}}}}}}
```

## The release object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"release":{"type":"object","title":"Release Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"belongs_to__application":{"description":"Type information not available yet"},"is_created_by__user":{"description":"Type information not available yet"},"raw_version":{"description":"Type information not available yet"},"semver":{"description":"Type information not available yet"},"semver_major":{"description":"Type information not available yet"},"semver_minor":{"description":"Type information not available yet"},"semver_patch":{"description":"Type information not available yet"},"semver_prerelease":{"description":"Type information not available yet"},"semver_build":{"description":"Type information not available yet"},"revision":{"description":"Type information not available yet"},"variant":{"description":"Type information not available yet"},"commit":{"description":"Type information not available yet"},"composition":{"description":"Type information not available yet"},"status":{"description":"Type information not available yet"},"source":{"description":"Type information not available yet"},"build_log":{"description":"Type information not available yet"},"start_timestamp":{"description":"Type information not available yet"},"end_timestamp":{"description":"Type information not available yet"},"update_timestamp":{"description":"Type information not available yet"},"is_invalidated":{"description":"Type information not available yet"},"release_version":{"description":"Type information not available yet"},"contract":{"description":"Type information not available yet"}}}}}}
```

## The release\_tag object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"release_tag":{"type":"object","title":"Release tag Model","properties":{"id":{"description":"Type information not available yet"},"release":{"description":"Type information not available yet"},"tag_key":{"description":"Type information not available yet"},"value":{"description":"Type information not available yet"}}}}}}
```

## The service object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"service":{"type":"object","title":"Service Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"application":{"description":"Type information not available yet"},"service_name":{"description":"Type information not available yet"}}}}}}
```

## The service\_install object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"service_install":{"type":"object","title":"Service install Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"device":{"description":"Type information not available yet"},"installs__service":{"description":"Type information not available yet"}}}}}}
```

## The user\_\_has\_\_public\_key object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"user__has__public_key":{"type":"object","title":"SSH key Model","properties":{"id":{"description":"Type information not available yet"},"user":{"description":"Type information not available yet"},"title":{"description":"Type information not available yet"},"public_key":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"}}}}}}
```

## The team object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"team":{"type":"object","title":"Team Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"name":{"description":"Type information not available yet"},"description":{"description":"Type information not available yet"},"belongs_to__organization":{"description":"Type information not available yet"}}}}}}
```

## The team\_fleet\_access object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"team_fleet_access":{"type":"object","title":"Team Fleet Access Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"team":{"description":"Type information not available yet"},"grants_access_to__application":{"description":"Type information not available yet"},"application_membership_role":{"description":"Type information not available yet"}}}}}}
```

## The team\_membership object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"team_membership":{"type":"object","title":"Team Membership Model","properties":{"id":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"},"user":{"description":"Type information not available yet"},"is_member_of__team":{"description":"Type information not available yet"}}}}}}
```

## The user object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"user":{"type":"object","title":"User Model","properties":{"id":{"description":"Type information not available yet"},"actor":{"description":"Type information not available yet"},"username":{"description":"Type information not available yet"},"created_at":{"description":"Type information not available yet"}}}}}}
```

## The whoami object

```json
{"openapi":"3.0.0","info":{"title":"Balena API Spec","version":"7.0.0"},"components":{"schemas":{"whoami":{"type":"object","title":"Who am I Model","properties":{"id":{"description":"Type information not available yet"},"username":{"description":"Type information not available yet"},"email":{"description":"Type information not available yet"}}}}}}
```