{"_id":"59c33312185f99001034da02","project":"568bdc1483d2061900d86cdc","version":{"_id":"59a72290d61777001b6c42c3","project":"568bdc1483d2061900d86cdc","__v":19,"createdAt":"2017-08-30T20:39:44.453Z","releaseDate":"2017-08-30T20:39:44.453Z","categories":["59a7236e3fe4d90025117c10","59a72eb6cb0db3001b84cfe2","59a734eb757d030019b85af8","59c0243b1b2d07001a9d2b76","59c035e42126e10028effb12","59c06c40df5b3c0010584a13","59c1a5852cabe5002641a3e7","59c2fb00b2b45c0010b7a3d7","59c32ceb9aea850010ac4130","59c32e6e190c90003cb0d12f","59c33affb2b45c0010b7aa23","59c7dfa457bd8200105444dc","59c7e975c50cf30010d712a0","59cffdef0cd4dd0010294d54","59d0622ca91a810032c8f60c","59d06733c1aec60026253065","59d174d44ac471001a07b123","59d5a5e323e6e800103defb2","59ecf1d8ed507c001c52b255"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.0.0","version":"0"},"category":{"_id":"59c32e6e190c90003cb0d12f","project":"568bdc1483d2061900d86cdc","version":"59a72290d61777001b6c42c3","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-21T03:13:50.363Z","from_sync":false,"order":14,"slug":"service-classes-api","title":"Service Classes API"},"user":"58cc41f21751ce2f003be3b7","__v":3,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-21T03:33:38.898Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"59a76194958d02000f677741","results":{"codes":[]},"examples":{"codes":[]},"method":"get","auth":"required","params":[{"_id":"59c332a02262d50032e94370","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"ecosystemId"},{"_id":"59c332a02262d50032e9436f","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"name"}],"url":"/:ecosystemId;:name"},"isReference":false,"order":2,"body":"# Details\n\nGet a service class.\n\nThe service class name must be explicitly specified using the ecosystem ID which contains that class.\n\nAn account token or server token may be used to run this endpoint.\n# Details\n\nGet a service class.\n\nThe service class name must be explicitly specified using the ecosystem ID which contains that class.\n\nAn account token or server token may be used to run this endpoint.\n\n# Parameters\n\n## path\n\n- ecosystemId (required): The ID of the [ecosystem](https://docs.droplit.io/docs/containers#section-ecosystems).\n- name (required): The unique name of a service class.\n\n# Responses\n\n## 200\n\n```\n{\n    \"name\": \"SERVICE-CLASS-NAME\",\n    \"service\": {\n        \"name\": \"SERVICE-NAME\"\n    },\n    \"type\": \"SERVICE-TYPE\",\n    \"createdAt\": \"YYYY-MM-DD HH:MM:SS ENCODED\",\n    \"ecosystemId\": \"ECOSYSTEM-ID\"\n}\n```\n\n## 400\n\n- __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint.\n- __Ecosystem Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the ecosystem ID. In this context, it means that the ID given for an ecosystem was not valid.\n\n## 404\n\n- __Ecosystem Not Found:__ This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does.\n- __Service Not Found:__ This error means that a service by the given name and/or format was not found.\n\n# Examples\n\n## HTTP\n\n```\nGET https://ioe.droplit.io/api/serviceclasses/ECOSYSTEM-ID;SERVICE-CLASS-NAME HTTP/1.1\nauthorization: TOKEN\n```\n\n## Droplit Console\n\n```\ndroplit serviceclass read SERVICE-CLASS-NAME --ecosystemId ECOSYSTEM-ID\n```","excerpt":"","slug":"service-classes-info","type":"endpoint","title":"Get a service class."}

getGet a service class.


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ecosystemId:
required
string
name:
required
string

Documentation

# Details Get a service class. The service class name must be explicitly specified using the ecosystem ID which contains that class. An account token or server token may be used to run this endpoint. # Details Get a service class. The service class name must be explicitly specified using the ecosystem ID which contains that class. An account token or server token may be used to run this endpoint. # Parameters ## path - ecosystemId (required): The ID of the [ecosystem](https://docs.droplit.io/docs/containers#section-ecosystems). - name (required): The unique name of a service class. # Responses ## 200 ``` { "name": "SERVICE-CLASS-NAME", "service": { "name": "SERVICE-NAME" }, "type": "SERVICE-TYPE", "createdAt": "YYYY-MM-DD HH:MM:SS ENCODED", "ecosystemId": "ECOSYSTEM-ID" } ``` ## 400 - __No Query String Allowed:__ The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint. - __Ecosystem Invalid:__ The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the ecosystem ID. In this context, it means that the ID given for an ecosystem was not valid. ## 404 - __Ecosystem Not Found:__ This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does. - __Service Not Found:__ This error means that a service by the given name and/or format was not found. # Examples ## HTTP ``` GET https://ioe.droplit.io/api/serviceclasses/ECOSYSTEM-ID;SERVICE-CLASS-NAME HTTP/1.1 authorization: TOKEN ``` ## Droplit Console ``` droplit serviceclass read SERVICE-CLASS-NAME --ecosystemId ECOSYSTEM-ID ```

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}