--- title: "Get Docker Host Owner Rule" method: POST path: "/docker-host-owner-rule/{id}/get-item" tags: ["Docker Host Owner Rule"] --- # Get Docker Host Owner Rule `POST /docker-host-owner-rule/{id}/get-item` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/docker-host-owner-rule/{id}/get-item` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to retrieve a single Docker Host Owner Rule by ID ## Path parameters - `id` string, uuid, required ## Request body - object - `select` DockerHostOwnerRuleSelectSchema: Select schema for DockerHostOwnerRule. Set fields to true to include them in the response. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `criteria` boolean - `projectId` boolean - `name` boolean - `description` boolean - `isEnabled` boolean - `notifyOwners` boolean - `dockerHostLabels` LabelRelationSelectSchema: What a select may name of the Label records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `name` boolean - `projectId` boolean - `color` boolean - `isArchived` boolean - `dockerHostNamePattern` boolean - `dockerHostDescriptionPattern` boolean - `ownerUsers` UserRelationSelectSchema: What a select may name of the User records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `name` boolean - `email` boolean - `profilePictureId` boolean - `twoFactorAuthEnabled` boolean - `ownerTeams` TeamRelationSelectSchema: What a select may name of the Team records a relation holds: set a field to true to include it. - `_id` boolean - `createdAt` boolean - `updatedAt` boolean - `deletedAt` boolean - `projectId` boolean - `name` boolean - `createdByUserId` boolean ## Response `200` Successful response - object - `data` DockerHostOwnerRule - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `version` number: Object version - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `projectId` string, uuid, required: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this Docker host owner rule. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `description` string: Description of this Docker host owner rule. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `isEnabled` boolean, required: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `notifyOwners` boolean: Send notifications to owner users and teams when they are added by this rule. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `dockerHostLabels` object[]: Only trigger for Docker hosts that have at least one of these labels. Leave empty to match regardless of labels. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `_id` string, uuid: Unique identifier for the entity - `dockerHostNamePattern` string: Regex (case-insensitive) matched against the Docker host name. Leave empty to match any name. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `dockerHostDescriptionPattern` string: Regex (case-insensitive) matched against the Docker host description. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `ownerUsers` object[]: Users to add as owners on the Docker host when this rule matches. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `_id` string, uuid: Unique identifier for the entity - `ownerTeams` object[]: Teams to add as owners on the Docker host when this rule matches. Permissions - Create: [Project Owner, Project Admin, Create Docker Host Owner Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [Project Owner, Project Admin, Edit Docker Host Owner Rule] - `_id` string, uuid: Unique identifier for the entity - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Read Docker Host Owner Rule], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)