Retrieve a service

Changed on Jul 11, 2025

Retrieves the details of a one-click service.

get/services/{service}

Request

Base URL
https://api.dnsimple.com/v2
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/dnsimple/apis/dnsimple-api/docs/services/:service/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

servicestring required

The service sid or id

Response

Successfully retrieved service.

Example response

{
  "data": {
    "id": 2,
    "name": "Service 2",
    "sid": "service2",
    "description": "Second service example.",
    "setup_description": null,
    "requires_setup": true,
    "default_subdomain": null,
    "created_at": "2014-02-14T19:15:19Z",
    "updated_at": "2016-03-04T09:23:27Z",
    "settings": [
      {
        "name": "username",
        "label": "Service 2 Account Username",
        "append": ".service2.com",
        "description": "Your Service2 username is used to connect services to your account.",
        "example": "username",
        "password": false
      }
    ]
  }
}

Changes

Jul 11, 2025v206780be0ef17 Revision changes
- breaking
  the response property /// became nullable for the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property /// became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
Jul 18, 2023v2c8591dcf8c29 Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property /// became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  the response property became optional for the status

Operation history

Retrieve a service

Request

Path parameters

Response 200OK

Example response

Changes

Response