--- title: "Create OID Collection Template" method: POST path: "/network-device-oid-template" tags: ["OID Collection Template"] --- # Create OID Collection Template `POST /network-device-oid-template` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/network-device-oid-template` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to create a new OID Collection Template ## Request body - object - `data` NetworkDeviceOidTemplateCreateSchema, required: Create schema for NetworkDeviceOidTemplate model. Create - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [No access - you don't have permission for this operation] - `name` string, required: The device type this template describes. Devices linked to it all collect the same OIDs. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `oids` object: SNMP OIDs (CPU, memory, temperature, or any custom OID) collected by every device linked to this template. You do not need OIDs for interfaces - bits in/out, errors, utilization and up/down are walked for every port automatically. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `tables` object: SNMP tables walked by every device linked to this template - one row per IPsec tunnel, Wi-Fi radio, routing neighbour, fan or power supply. Each table lists the column OIDs to collect and, optionally, the columns that name each row. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] ## Response `201` Created successfully - object - `data` NetworkDeviceOidTemplateReadSchema: Read schema for NetworkDeviceOidTemplate model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [No access - you don't have permission for this operation] - `name` string, required: The device type this template describes. Devices linked to it all collect the same OIDs. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `slug` string: Friendly globally unique name for your object. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [No access - you don't have permission for this operation] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `oids` object: SNMP OIDs (CPU, memory, temperature, or any custom OID) collected by every device linked to this template. You do not need OIDs for interfaces - bits in/out, errors, utilization and up/down are walked for every port automatically. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `tables` object: SNMP tables walked by every device linked to this template - one row per IPsec tunnel, Wi-Fi radio, routing neighbour, fan or power supply. Each table lists the column OIDs to collect and, optionally, the columns that name each row. Permissions - Create: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Create OID Collection Template], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [Project Owner, Project Admin, Project Member, Settings Admin, Settings Member, Edit OID Collection Template] - `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, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], Update: [No access - you don't have permission for this operation] - `deletedByUserId` string, uuid: User ID who deleted this object (if this object was deleted by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Settings Admin, Settings Member, Settings Viewer, Read OID Collection Template], 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. - `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)