Comment API
https://api.gandi.net/v5/comment
Manage your comments on gandi products
Manage your comments on gandi products ¶
https://api.gandi.net/v5/comment/comments/{id}
get Return the comment ¶
Request
URI Parameters
- id ⁠stringThe gandi product entity_id
- id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
200
Body
application/json
⁠objectWith the following properties:
- content ⁠string
- id ⁠stringThe gandi product entity_id.
Optional
- created_at ⁠datetime
- updated_at ⁠datetime
- user ⁠object
With the following properties:
- id ⁠stringUUID
- name ⁠string
- sharing_id ⁠stringUUID
- id ⁠string
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" } }
403
Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Bad authentication attempt because of a wrong API Key.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
post Set the comment for the entity corresponding to the id ¶
Request
URI Parameters
- id ⁠stringThe gandi product entity_id
- id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
Optional
- Dry-Run ⁠integerIf this header's value is
1
the request's parameters will only be checked; the operation will not actually be performed.
- Authorization ⁠string
Body
application/json
⁠objectWith the following properties:
Required
- content ⁠stringThe note content.
Example:{ "content": "This domain must be renewed." }
- content ⁠string
Responses
200
Dry-Run response. You will get this response when you send your request. with a
Dry-Run: 1
header.Headers
Optional
- Warning ⁠stringWarning message
- Warning ⁠string
Body
application/json
⁠objectWith the following properties:
- status ⁠string
One of: "success", "error"
Response status.
Optional
- errors ⁠arrayA list of all the errors encountered during validation.
Of items of type:
- object
With the following properties:
- description ⁠stringError message.
- location ⁠string
One of: "header", "path", "querystring", "body"
The field's location in the HTTP response. - name ⁠stringThe xpath of the field.
- description ⁠string
- object
- status ⁠string
202
The request has been accepted.
Headers
Optional
- Location ⁠string
Body
application/json
⁠objectWith the following properties:
- message ⁠stringConfirmation message.
- message ⁠string
403
Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Bad authentication attempt because of a wrong API Key.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
delete Delete the comment for the entity corresponding to the id. ¶
Request
URI Parameters
- id ⁠stringThe gandi product entity_id
- id ⁠string
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string
Responses
204
Comment was deleted
403
Access to the resource is denied. Mainly due to a lack of permissions to access it.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
401
Bad authentication attempt because of a wrong API Key.
Body
application/json
⁠objectWith the following properties:
- cause ⁠string
- code ⁠integer
- message ⁠string
- object ⁠string
Secured by
Authentication with API Key
This authentication scheme allows you to pass your Gandi API Key and be granted access to your resources, as your permissions allow.
Headers
Required
- Authorization ⁠stringThe
Authorization
header must start withApikey
, followed by the user's API Key.Example:Apikey your-api-key
- Authorization ⁠string