--- title: List host groups slug: api/list-host-groups docTags: createdAt: 2026-03-01T03:12:36.506Z --- { "id": "1UZpx1GUc1f3RrZxaq8Lq", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://openapi.sine.co/v1/api/hosts/groups", "servers": [ { "url": "https://openapi.sine.co/v1/api/hosts/groups", "description": "Sine Public API" } ], "name": "List host groups", "description": "Returns a list of all host groups.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "required", "name": "x-sine-team-id", "type": "string", "description": "The UUID of the Team", "format": "uuid" } ], "queryParameters": [ { "kind": "optional", "name": "limit", "type": "integer", "example": 10, "description": "Maximum number of records to be returned", "default": 100, "minimum": 1, "maximum": 1000 }, { "kind": "optional", "name": "next", "type": "string", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IjIwMjEwOTEyNCJ9.eyJuZXh0IjoyLCJzZXJ2aWNlIjoiZ2V0U2l0ZXMiLCJpYXQiOjE2MzI3MjE2OTAsImV4cCI6MTYzMjgwODA5MH0.puXUEpDhCTbAEC8b9LOi90qF68I-HXerLBxvJfymJx0", "description": "The 'next page token' required to fetch the next page of host groups in a subsequent request" }, { "kind": "optional", "name": "nameIncludes", "type": "string", "description": "Search for host groups by name." }, { "kind": "optional", "name": "siteId", "type": "string", "example": "019fe2b4-f2ee-4a19-873d-ddb4f014dfce", "description": "Search for host groups by site id.", "format": "uuid" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "bearerAuth", "name": "bearerAuth", "kind": "optional", "type": "http", "description": "

To obtain a token, call POST /oauth2/token with your client_id and client_secret. The returned access_token is then used as a Bearer token for all subsequent requests.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "

OK - Request completed successfully. The first page of host groups matching the query parameters (if specified) will be included in the response.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "records", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "required", "type": "string", "description": "", "example": "ecbc5ca7-d6e1-4133-90a0-e7070d993f18", "format": "uuid" }, { "name": "name", "kind": "required", "type": "string", "description": "

The display name of the host group. It must be unique for each site and for team-scoped host groups on the same team.

", "example": "Host Group Name" }, { "name": "private", "kind": "optional", "type": "boolean", "description": "" }, { "name": "site", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "", "format": "uuid" }, { "name": "name", "kind": "optional", "type": "string", "description": "", "example": "Site Name" } ] } ] }, { "name": "next", "kind": "optional", "type": "string", "description": "An opaque token that can be used to retrieve the next page of results", "example": "dGhpcyB0b2tlbiBpcyBvcGFxdWUsIGRvbid0IHRyeSB0byBkZWNvZGUgaXQ=" } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"BAD_REQUEST\",\"message\":\"The request is invalid\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "BAD_REQUEST" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom Error Message", "example": "The request is invalid" } ], "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"UNAUTHORIZED\",\"message\":\"Invalid authentication credentials\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "UNAUTHORIZED" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "Invalid authentication credentials" } ], "isExpanded": true } ] }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"FORBIDDEN\",\"message\":\"You are not allowed to access this information\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "FORBIDDEN" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "You are not allowed to access this information" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Resource not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"SITE_NOT_FOUND\",\"message\":\"SiteNotFoundError\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "SITE_NOT_FOUND" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "SiteNotFoundError" } ], "isExpanded": true } ] }, { "statusCode": "424", "description": "Service dependency failed", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"CONSUMER_ERROR\",\"message\":\"Unexpected error while communicating with downstream service, please try again\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "CONSUMER_ERROR" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "Unexpected error while communicating with downstream service, please try again" } ], "isExpanded": true } ] }, { "statusCode": "429", "description": "Too many requests", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"RATE_LIMITED\",\"message\":\"API rate limit exceeded\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "RATE_LIMITED" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "API rate limit exceeded" } ], "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal server error", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"code\":\"INTERNAL_SERVER_ERROR\",\"message\":\"Something went wrong, please try again later\"}", "description": "", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "HTTP status code", "example": "INTERNAL_SERVER_ERROR" }, { "name": "message", "kind": "optional", "type": "string", "description": "Custom error message", "example": "Something went wrong, please try again later" } ], "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "5jm-6dJtnNhtWUr3Qjt8w", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://openapi.sine.co/v1/api/hosts/groups?limit=100' \\\n --header 'accept: application/json' \\\n --header 'x-sine-team-id: string'" }, { "id": "di_luZWaRCsB28WjHt3TN", "language": "javascript", "label": "JavaScript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\nmyHeaders.append(\"x-sine-team-id\", \"string\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://openapi.sine.co/v1/api/hosts/groups?limit=100\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "mXFPO0xAujSgdeAb5V2AH", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://openapi.sine.co/v1/api/hosts/groups?limit=100\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json',\n 'x-sine-team-id': 'string'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "5jm-6dJtnNhtWUr3Qjt8w" }, "results": { "languages": [ { "id": "AWDa2w8antg8Cadsi9lQd", "language": "200", "code": "// OK - Request completed successfully. The first page of host groups matching the query parameters (if specified) will be included in the response.\n{\n \"records\": [\n {\n \"id\": \"ecbc5ca7-d6e1-4133-90a0-e7070d993f18\",\n \"name\": \"Host Group Name\",\n \"private\": false,\n \"site\": {\n \"id\": \"\",\n \"name\": \"Site Name\"\n }\n }\n ],\n \"next\": \"dGhpcyB0b2tlbiBpcyBvcGFxdWUsIGRvbid0IHRyeSB0byBkZWNvZGUgaXQ=\"\n}" }, { "id": "rWpefWJuvjTpG9Ea3ix34", "language": "400", "code": "// Bad request\n{\n \"code\": \"BAD_REQUEST\",\n \"message\": \"The request is invalid\"\n}" }, { "id": "4FqEE2hlyOm8JclclOha1", "language": "401", "code": "// Unauthorized\n{\n \"code\": \"UNAUTHORIZED\",\n \"message\": \"Invalid authentication credentials\"\n}" }, { "id": "WMxv2zJ3SU6yj2rT7vixg", "language": "403", "code": "// Forbidden\n{\n \"code\": \"FORBIDDEN\",\n \"message\": \"You are not allowed to access this information\"\n}" }, { "id": "_Nx9nEoksQtW1UMq_gLTn", "language": "404", "code": "// Resource not found\n{\n \"code\": \"SITE_NOT_FOUND\",\n \"message\": \"SiteNotFoundError\"\n}" }, { "id": "pTLhAyds2zV1bF7qCxs7r", "language": "424", "code": "// Service dependency failed\n{\n \"code\": \"CONSUMER_ERROR\",\n \"message\": \"Unexpected error while communicating with downstream service, please try again\"\n}" }, { "id": "ZouayEtj55CdWgKsI5A-m", "language": "429", "code": "// Too many requests\n{\n \"code\": \"RATE_LIMITED\",\n \"message\": \"API rate limit exceeded\"\n}" }, { "id": "MZg-IMytp9j5XEYcZMRGQ", "language": "500", "code": "// Internal server error\n{\n \"code\": \"INTERNAL_SERVER_ERROR\",\n \"message\": \"Something went wrong, please try again later\"\n}" } ], "selectedLanguageId": "AWDa2w8antg8Cadsi9lQd" } }, "children": [ { "text": "" } ] }