Sign in
Websites

Create website

Changed on

Creates a new website configuration for IPFS content.

Sets up a website with a domain name pointing to IPFS content. Supports automatic DNS management and SSL certificate provisioning.

Prerequisites: Domain must be configured, target CID must exist

See also:.*

post/api/websites

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/websites
  • Auth: none declared

Request body

dns_hosting_enabledboolean
domainstring
generateboolean
labelstring
namespacestring
platform_domainstring
platform_namespacestring
target_hashstring required
target_typestring required

Response

Website created

active_cidstring
createdstring date-time required
dns_hosting_enabledboolean required
domainstring required
expiredboolean required
gateway_domainstring
idinteger required
ipns_key_idinteger
is_subdomainboolean required
last_checked_atstring date-time
statusstring required
target_hashstring required
target_typestring required
updatedstring date-time required
validation_expires_atstring date-time
validation_record_hoststring
validation_tokenstring required
zone_idinteger

Changes

  • 06e0fa4f446eRevision changes
    • breaking

      removed the success response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      added the new failed enum value to the / response property for the response status

    • warning

      added the new issuing enum value to the / response property for the response status

    • warning

      added the new pending enum value to the / response property for the response status

    • warning

      added the new ready enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • b97dd0465ab3Revision changes
    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • breaking

      the response's property type changed from string to object for status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status