Comment API

URI Parameters

• • id ⁠string
    The gandi product entity_id

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  • content ⁠string
  • id ⁠string
    The gandi product entity_id.

  Optional

  • created_at ⁠datetime
  • updated_at ⁠datetime
  • user ⁠object

    With the following properties:

    • id ⁠string
      UUID
    • name ⁠string
    • sharing_id ⁠string
      UUID
  Example:

  {
    "id": "ae5680b2-8c8f-11eb-8460-00163ec4cb00",
    "content": "This is a comment.",
    "created_at": "2021-05-18T11:36:59Z",
    "updated_at": "2021-05-18T11:36:59Z",
    "user": {
      "sharing_id": "3c2f29e4-17be-4db3-b8eb-ec8a3fa96bc0",
      "id": "3c2f29e4-17be-4db3-b8eb-ec8a3fa96bc0",
      "name": "alicia"
    }
  }

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • id ⁠string
    The gandi product entity_id

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

  Optional

  • Dry-Run ⁠integer
    If this header's value is 1 the request's parameters will only be checked; the operation will not actually be performed.

Body

• application/json

  ⁠object

  With the following properties:

  Required

  • content ⁠string
    The note content.
  Example:

  {
    "content": "This domain must be renewed."
  }

Headers

• Optional

  • Warning ⁠string
    Warning message

Body

• application/json

  ⁠object

  With the following properties:

  • status ⁠string

    One of: "success", "error"

    Response status.

  Optional

  • errors ⁠array
    A list of all the errors encountered during validation.

    Of items of type:

    • object

      With the following properties:

      • description ⁠string
        Error message.
      • location ⁠string

        One of: "header", "path", "querystring", "body"

        The field's location in the HTTP response.
      • name ⁠string
        The xpath of the field.

Headers

• Optional

  • Location ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • message ⁠string
    Confirmation message.

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

URI Parameters

• • id ⁠string
    The gandi product entity_id

Headers

• Required

  • Authorization ⁠string
    The Authorization header must start with Apikey, followed by the user's API Key.
    Example: Apikey your-api-key

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string

Body

• application/json

  ⁠object

  With the following properties:

  • cause ⁠string
  • code ⁠integer
  • message ⁠string
  • object ⁠string