RESTful Provisioning Protocol (RPP)

Introduction This document describes an Application Programming Interface (API) API based on the HTTP protocol and the principles of . Conforming to the REST constraints is generally referred to as being "RESTful". Hence the API is dubbed: "'RESTful Provisioning Protocol" or "RPP" for short. The RPP API is designed to be used for the provisioning and management of objects in a shared database, such as domain names, hosts, and entities.

Terminology In this document the following terminology is used. REST - Representational State Transfer (). An architectural style. RESTful - A RESTful web service is a web service or API implemented using HTTP and the principles of . EPP RFCs - This is a reference to the EPP version 1.0 specifications , , and . RESTful Provisioning Protocol or RPP - The protocol described in this document. URL - A Uniform Resource Locator as defined in . Resource - An object having a type, data, and possible relationship to other resources, identified by a URL. RPP client - An HTTP user agent performing an RPP request RPP server - An HTTP server responsible for processing requests and returning results in any supported media type. JWT - JSON Web Token as defined in .

Conventions Used in This Document The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT","SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in . In examples, indentation and white space in examples are provided only to illustrate element relationships and are not REQUIRED features of the protocol. All example requests assume a RPP server using HTTP version 2 is listening on the standard HTTPS port on host rpp.example. An authorization token has been provided by an out of band process and MUST be used by the client to authenticate each request.

Request Headers A RPP request does not always require a request message body. The information conveyed by the HTTP method, URL, and request headers may be sufficient for the server to be able to successfully processes a request. However, the client MUST include a request message body when the server requires additional attributes to be present in the request message. The RPP HTTP headers listed below use the "RPP-" prefix, following the recommendations in .

RPP-Cltrid: The client transaction identifier is the equivalent of the clTRID element defined in and MUST be used accordingly, when the HTTP message body does not contain an EPP request that includes a cltrid.
RPP-Authorization: The client MAY use this header to send authorization information in the format <method> <authorization information>, similar to the HTTP Authorization header, defined in [RFC9110, Section 11.6.2]. The <method> indicates the type of authorization being used. For EPP object authorization information, for example the authorization information used for domain names described in [RFC5731, Section 2.3], a new authinfo method is defined and MUST be used. The <authorization information> defines the following comma separated fields:
- value (REQUIRED): Base64 encoded EPP password-based authorization information. Base64 encoding is used to prevent problems when special characters are present that may conflict with the format rules for the Authorization header.
- roid (OPTIONAL): A Roid as defined in , , and . The roid is used to identify the object for which the authorization information is provided. If the roid is not provided, then the server MUST assume that the authorization information is linked to the object identified by the URL of the request.

Use of the RPP-Authorization header: The value of the RPP-Authorization header is case sensitive. The server MUST reject requests where the case of the header value does not match the expected case. The RPP-Authorization header is specific to the user agent and MUST NOT be cached, as recommended by , the server MUST use the correct HTTP cache directives to prevent caching of the RPP-Authorization header.

RPP-Profile: The client MUST use this header to indicate the profiles is used in the request.

Response Headers The server HTTP response contains a status code, headers, and MAY contain an RPP response message in the message body. HTTP headers are used to transmit additional data to the client and MAY be used to send RPP process related data to the client. HTTP headers used by RPP MUST use the "RPP-" prefix, the following response headers have been defined for RPP.

RPP-Svtrid: This header is the equivalent of the "svTRID" element defined in and MUST be used accordingly when the RPP response does not contain an EPP response in the HTTP message body. If an HTTP message body with the EPP XML equivalent "svTRID" exists, both values MUST be consistent.
RPP-Cltrid: This header is the equivalent of the "clTRID" element defined in and MUST be used accordingly when the RPP response does not contain an EPP response in the HTTP message body. If the contents of the HTTP message body contains a "clTRID" value, then both values MUST be consistent.
RPP-Code: This header is the equivalent of the EPP result code defined in and MUST be used accordingly. This header MUST be added to all responses and MAY be used by the client for easy access to the result code, without having to parse the HTTP response message body.

For the EPP codes related to session management (1500, 2500, 2501 and 2502) there are no corresponding RPP codes. In order for RPP to be backwards compatible with EPP, RPP will use 5-digit coding of the result codes, where first digit will denote origin specification of the result codes. For Result Codes the leading digit MUST be "0". For RPP result codes the leading digit MUST be "1". For avoidance of confusion RPP MUST not define new codes with the same semantic meaning as already defined in EPP. For RPP codes the remaining 4 digits MUST keep the same semantics as Result Codes.

RPP-Queue-Size: Return the number of unacknowledged messages in the client message queue. The server MAY include this header in all RPP responses.

Error handling and relation between HTTP status codes and RPP codes RPP leverages standard HTTP status codes to reflect the outcome of RPP operations. The RPP result codes are based on the EPP result codes defined in . This allows clients to handle responses generically using common HTTP patterns. While the HTTP status code provides the primary, high-level outcome, the specific RPP result code MUST still be provided in the RPP-Code HTTP header for detailed diagnostics. The mapping strategy is to use the most specific HTTP code that accurately reflects the operation's result. For common and well-defined outcomes, a specific HTTP status code is used. For example, an attempt to access a non-existent resource (EPP code 2302) MUST return 404 Not Found, and an attempt to create a resource that already exists (EPP code 2303) MUST return 409 Conflict. This allows a client to handle these common situations based on the HTTP code alone. For all other failures, a generic HTTP status code is used. Client-side errors (e.g., syntax, parameter, or policy violations) MUST return 400 Bad Request. Server-side failures MUST return 500 Internal Server Error. The server MUST return HTTP status codes, following the mapping rules in Table 1. Table 1: RPP result code and HTTP Status-Code mapping.

HTTP Status-Code	Description	Corresponding RPP result code(s)
Success (2xx)
200 OK	The request was successful (e.g., for GET or UPDATE).	01000 (in all cases not specified otherwise), 01300, 01301
201 Created	The resource was created successfully.	01000 for resource creating requests (POST/PUT)
202 Accepted	The request was accepted for asynchronous processing.	01001
204 No Content	The resource was deleted successfully.	01000 for DELETE
Client Errors (4xx)
400 Bad Request	Generic client-side error (syntax, parameters, policy).	02000-02005, 02104-02106, 02300-02301, 02304-02308
403 Forbidden	Authentication or authorization failed.	02200-02202
404 Not Found	The requested resource does not exist.	02303
409 Conflict	The resource could not be created because it already exists.	02302
Server Errors (5xx)
500 Internal Server Error	Generic server-side error; command failed.	02400
501 Not Implemented	The requested command or feature is not implemented.	02100-02103

Some EPP result codes, like 01500, 02500, 02501 and 02502 are related to session management and therefore not applicable to a sessionless RPP protocol.

Problem Detail responses for errors When an error occurs that prevents processing of the requested action, an RPP server MUST respond using a Problem Detail document detailing what went wrong, or what was not acceptable to the server. The type field MUST be the urn:ietf:params:rpp:problem URN. The status field MUST reflect the HTTP status code. The document MUST contain an errors element, as a list of objects detailing individual errors. This document consists of the following fields:

type: (required, string) This field MUST always contain the fixed string value urn:ietf:params:rpp:error to indicate that this is an RPP Problem Detail response.
title: (required, string) A short human-readable description of the Problem Detail type.
errors: (optional, array of error objects) MUST contain objects detailing information about the specific errors that occurred, including optional references to which values in the original request were not acceptable to the server.

The error object consist of the following fields:

type: (required, string) This field SHOULD be a URI that identifies the error type. This URI MAY be dereferenceable to obtain human-readable documentation about the error type.
result: (required, string) This field MUST contain the RPP result code associated with the error.
paths: (optional, list of strings) The JSONPath to the value(s) in the request that caused the error. This field MAY be omitted if no specific value in the request can be identified as the cause of the error.
reason: (required, string) A human-readable detailed description of the error.

RPP specifications and/or extensions MAY add extension fields to the error object, to convey additional information about the causes of the error. For example, to indicate the account balance on a billing failure, the following Problem Detail response could be used: Problem Detail response containing multiple errors for a domain create request using an invalid domain name (_$.example), JSONPaths are specified in the error objects to indicate which value in the request caused the error:

Bootstrapping The client MUST be able to bootstrap itself by discovering the location of an RPP server. Not having a fixed location for the RPP server is a fundamental design principle of RPP, as it allows for a more flexible and scalable architecture. The client MUST use either the IANA registry for RPP servers or a DNS lookup using an SRV record as defined in . The format and procedure for adding an RPP server to the IANA registry is defined in the IANA Considerations section below. For DNS-based bootstrapping, an RPP server MUST publish an SRV record in each DNS zone that is served by the RPP server. The owner name of the SRV record MUST be _rpp._tcp.<zone>. If multiple SRV records are returned, the client MUST select the RPP server according to the priority and weight rules in . The client MUST ignore SRV records with a target of . (service not available). The SRV record provides the target host and port of the RPP service. The client MUST construct the URL for the well-known endpoint (defined in the Discoverability section below) as:

https://<target>:<port>/.well-known/rpp when <port> is not 443
https://<target>/.well-known/rpp when <port> is 443

The client MUST use the constructed URL to discover the capabilities of the RPP server, as defined in the Discoverability section below. Example SRV record for an RPP server for the TLD "example" running HTTPS on port 443 at rpp.example.: In this example, the well-known endpoint URL is https://rpp.example/.well-known/rpp.

Discoverability RPP server capabilities MUST be discoverable by clients. The server MUST provide a well-known endpoint at /.well-known/rpp at the root of the RPP server, this endpoint MUST return a JSON document containing the capabilities of the RPP server. The well-known endpoint MUST be accessible without authentication, and the client MUST be able to access this endpoint before authenticating with the server. The well-known endpoint MUST be accessible using the HTTP GET method and MUST return an HTTP status code 200 (OK) if the request was successful. The response message body MUST contain a JSON document describing the capabilities of the RPP server using the following fields:

base_url: (required, string) The base URL for the RPP API, this is the URL that MUST be used as the base for all endpoint URL templates.
version: (required, string) The version of the RPP API supported by the server, for example "1.0".
tlds: (required, array of strings) A list of TLDs supported by the server, for example "example", "org".
extensions: (optional, array of extension objects) A list of supported extensions, each extension object MUST contain the following fields:
- name: (required, string) A short name for the extension, for example "registry fee extension".
- id: (required, string) A unique URN identifier for the extension, for example "urn:ietf:params:rpp:extension:registry-fee".
- version: (required, string) The version of the extension supported by the server, for example "1.0".
- url: (required, string) for standard extensions, this MUST be the URL for the extension in the IANA registry, for private extensions, this MUST be the URL for the extension specification, the domain name used in the URL MUST resolve and the URL MUST be accessible to the client.
profiles: (optional, array of profile objects) A list of supported profiles, each profile object MUST contain the following fields:
- name: (required, string) A short name for the profile, for example "domain provisioning profile".
- id: (required, string) A unique URN identifier for the profile, for example "urn:ietf:params:rpp:profile:domain-provisioning-1.0".
- version: (required, string) The version of the profile supported by the server, for example "1.0".
- url: (required, string) for standard profiles, this MUST be the URL for the profile in the IANA registry, for private profiles, this MUST be the URL for the profile specification, the domain name used in the URL MUST resolve and the URL MUST be accessible to the client.
objects: (required, array) A list of supported resource collections, for example "domains", "hosts", "entities".
authentication: (optional, array of strings) A list of supported authentication methods, for example "Bearer", "Basic".
endpoints: (required, array of endpoint objects) A list of available endpoints, each endpoint object MUST contain the following fields:
- name: (required, string) A short name for the endpoint, for example "availability", "info", "poll", "create", "delete", "renewal" or "transfer".
- url_template: (required, string) The URI template for the endpoint, using the syntax defined in .
maintenance: (optional, array) An array containing information about upcoming planned maintenance windows of the server, with the following fields:
- start_time: (required, string) The start time of the maintenance window in ISO 8601 format.
- end_time: (required, string) The end time of the maintenance window in ISO 8601 format.
- description: (optional, string) A human-readable description of the maintenance window.

The following template variables are defined for use in RPP endpoint URL templates:

collection: The resource collection type (e.g., "domains", "hosts", "entities")
id: The unique identifier for a resource instance within a collection
process_name: The name of a process associated with a resource (e.g., "transfers", "renewals")
process_id: The unique identifier for a specific process instance

Example discovery response document:

Workflow The steps for a typical workflow of provisioning an object using RPP without knowing the location and capabilities of the server are as follows, the first three steps are optional, the client can choose to skip any of these steps if it already has the required information from a previous interaction or configuration.

Bootstrap (optional): The client discovers the location of the RPP server by looking up the IANA registry for RPP servers or by performing a DNS SRV lookup as defined in .
Discover capabilities (optional): The client retrieves the capabilities of the RPP server by sending a GET request to the well-known endpoint at /.well-known/rpp.
Extract RPP URLs (optional): The client extracts the base URL and endpoint URL templates from the discovery response, and uses this information to construct the URLs for the desired operations.
Perform provisioning operations: The client performs provisioning operations by sending HTTP requests to the appropriate endpoint URLs, using the HTTP method and request message body as required by the specific operation.

Versioning RPP is designed to be extensible and backward compatible. The version of the RPP API is indicated in the URL path, for example: https://rpp.example/rpp/v1/. The server MUST support at least one version of the RPP API, and MUST return a 404 Not Found status code for requests using an unsupported version. The versioning scheme uses the Semantic Versioning format defined in , but only the major version number is used to indicate breaking changes. The minor and patch version numbers are not used in an URL path, but can be used in the media type or in the message body to indicate non-breaking changes. The following RPP elements include versioning support:

Endpoints: The server MUST support at least one version of the RPP API, and MUST return a 404 Not Found status code for requests using an unsupported version.
Messages: A request and response message MUST include the version of the RPP API it is compatible with.
Extensions: RPP extensions MUST include the version of the RPP API they are compatible with.
Profiles: RPP profiles MUST include the version of the RPP API they are compatible with.
Media types: RPP media types MUST include the version of the RPP API they are compatible with.
Result codes: RPP result codes may be added by extensions or updates to the core RPP specification.

Endpoints The base_url element of the RPP Discovery response MAY include the version of the RPP API supported by the server. The client MUST use this base_url for all subsequent requests to the server. For example, if the version is 1.2.3, the base_url is https://rpp.example/rpp/v1/, then the client MUST use this URL for all subsequent requests to the server, and MUST not use a different version in the URL path.

Messages The version element of the RPP request and response messages MUST include the version of the RPP API that the message is compatible with. The server MUST reject requests with a version that is not supported by the server, and MUST return a RPP Client error code.

Extensions The RPP server MUST include the version for each extension in the RPP Discovery response. The client MUST use this version information to determine which extensions are supported by the server, and to ensure that it uses the correct version of the extension when making requests to the server. A request using an extension MUST include the version of the extension. The server MUST reject requests using extensions with a version that is not supported by the server, and MUST return a RPP Client error code. The following is an example of how the version information for an extension can be included in the RPP Discovery response:

Profiles The RPP server MUST include the version for each profile in the RPP Discovery response. The client MUST use this version information to determine which profiles are supported by the server, and to ensure that it uses the correct version of the profile when making requests to the server. A request using a profile MUST include the version of the profile. The server MUST reject requests using profiles with a version that is not supported by the server, and MUST return a RPP Client error code. The following is an example of how the version information for a profile can be included in the RPP Discovery response:

Media types RPP media types are used to indicate the format of the request and response messages, and MUST include a parameter indicating the name of the profile they are compatible with. The server MUST use the profile information in the media type to determine which features, extensions and versions to use when processing the request, and to ensure that it returns a response that is compatible with the client. The client MUST use the profile information in the media type to determine which features, extensions and versions to use when processing the response, and to ensure that it can correctly interpret the response. The definition of profile parameters in media types is described in section ....

Profiles A profile is a named set of protocol features and versions that are used to define the compatibility and capabilities of RPP server implementations, allowing for better interoperability between different implementations. Using profiles helps to simplify the implementation and deployment of RPP by providing a clear and concise way for the client and server to communicate their capabilities and requirements. A profile is identified by a unique name and may be published as a standard profile in the IANA registry for RPP profiles, to promote interoperability and standardization across implementations. Standard profiles names MUST use the RPP URN namespace defined in this document, for example: urn:ietf:params:rpp:profile:{profile_name}. The profile name MUST be unique within the RPP URN namespace and SHOULD be descriptive of the features and versions included in the profile. A profile can also be defined as a private profile, which is not published in the IANA registry, but is used by specific server implementations only. A private profile can be defined by a server operator to specify the features and versions supported by their implementation. If the profile is not published in the IANA registry, then the server operator MUST ensure that the profile name is globally unique to avoid conflicts with other profiles, the use of reverse domain name notation is RECOMMENDED for private profiles to ensure uniqueness.

Definition A profile definition MUST contain the following fields, private profiles may contain additional fields as needed:

name: A unique name that identifies the profile.
description: A human-readable description of the profile and its intended use.
version: The version of the profile.
rpp_version: The minimum version of the RPP protocol that is supported or required for the profile.
objects: A list of objects allowed for provisioning operations, for example "domains", "hosts", "entities", etc.
extensions: A list of extensions, including their versions, that are supported or required for the profile.
profile: A base profile that is extended by this profile. The base profile MUST be published in the IANA registry for RPP profiles, or be made available to the client using other means.

Example JSON representation for a standard profile named "example-profile" that supports RPP version 1.0 and includes two extensions, "rppExample" version 1.0 and "rppOther" version 1.1. The profile also "extends" the "base-profile" profile, which is defined in the IANA registry for RPP profiles and supports RPP version 1.0.

Inheritance A profile can include another profile, which is referred to as "inheriting" from that profile. When a profile inherits from another profile, it means that the features and versions defined in the inherited profile are also included in the inheriting profile. This allows for the creation of more complex profiles by building upon existing profiles. For example, a profile named "example-profile" could inherit from a base profile named "base-profile", which includes a set of common features and versions. The "example-profile" could then add additional features and versions on top of the ones defined in the "base-profile", or it can override some of the features and versions from the "base-profile". This allows for greater flexibility and modularity in defining profiles, as well as promoting reuse of common features and versions across different profiles. However, it is important to note that the use of inheritance in profiles can also make things more complicated, as it can create dependencies between profiles and make it harder to understand the features and versions included in a profile. Therefore, it is recommended to use inheritance with caution and to clearly document the relationships between profiles. The depth of inheritance MUST be limited to 1 to provent excessive complexity, and profile designers MUST NOT create circular dependencies between profiles, where a profile inherits from itself directly. This is an example of the parent base-profile used in the previous example, it contains a single extension "rppOther" version 1.0 and does not include any other profiles: The example profile definition shown in uses the "base-profile" as its base and inherits its features and also overrides the version of the "rppOther" extension defined in the base profile.

Signalling This document descibes two distinct methods for signalling the profile used in a RPP request or response, the first method uses a dedicated HTTP header, the second method uses media type parameters. The two methods MUST not be used simultaneously in a single request or response. If both methods are used in a single request or response, then the server MUST return an HTTP error response and include a Problem Detail response in the message body.

Header signalling The client MUST use the RPP-Profile header to indicate the name of the profile that is to be used for the request. The value of this header MUST be of the type parameter described in , the first parameter MUST uniquely identify a profile, for example urn:ietf:params:rpp:profile:example-profile, followed by the version parameter. If the server does not support the indicated profile or version, then the server MUST return an HTTP error response and include a Problem Detail response in the message body. The ABNF for Profile header value is as follows: Example:

Media type parameter signalling When using Media type parameter signalling, the client and the server MUST use media type parameters in the Accept and Content-Type headers to indicate the name and version of the profile used in the request. The media type parameters MUST be defined as follows:

profile: The value of this parameter MUST uniquely identify the profile, for example urn:ietf:params:rpp:profile:example-profile.
version: The value of this parameter MUST indicate the version of the profile used in the request.

The ABNF for media type parameter signalling is as follows: Example for the media type application/rpp+json with profile parameters indicating the use of the "example-profile" profile version 1.0.:

Endpoints Endpoints are described using URI Templates relative to a discoverable base URL, as recommended by . Some RPP endpoints do not require a request and/or response message. The RPP endpoints are defined using the following URI Template syntax:

{c}: An abbreviation for {collection}: this MUST be substituted with "domains", "hosts", "entities" or another collection of objects.
{i}: An abbreviation for an object identifier, this MUST be substituted with the value of a domain name, hostname, contact-id or a message-id or any other defined object.

A RPP client MAY use the HTTP GET method for executing informational request only when no request data has to be added to the HTTP message body. Sending content using an HTTP GET request is discouraged in , there exists no generally defined semantics for content received in a GET request. When an RPP object requires additional information, the client MUST use the HTTP POST method and add the query command content to the HTTP message body.

Availability for Creation The Availability for Creation endpoint is used to check whether an object can be successfully provisioned. Two distinct methods are defined for checking the availability of provisioning of an object, the first method uses the HEAD method for a quick check to find out if the object can be provisioned. The second method uses the GET method to retrieve additional information about the object's availability for provisioning, for example about pricing or additional requirements to be able to provision the requested object. When the client uses the HTTP HEAD method, the server MUST respond with an HTTP status code 200 (OK) if the object can be provisioned or with an HTTP status code 404 (Not Found) if the object cannot be provisioned. When the client uses the HTTP GET method, the server MUST respond with an HTTP status code 200 (OK) if the object can be provisioned. The server MUST include a message body containing more detailed availability information, for example about pricing or additional requirements to be able to provision the requested object. The message body MAY be and empty JSON object if no additional information is applicable. If the object cannot be provisioned then the server MUST return an HTTP status code 404 (Not Found) and include a problem statement in the message body. As an extension point the server MAY define and the client MAY use additional HTTP query parameters to further specify the check operation or the kind of response information that shall be returned. For example Registry Fee Extension defines a possibility to request certain currency, only certain commands or periods. Such functionality would add query parameters, which could be used with GET request to receive additional pricing information with the response. HEAD request would not be affected in this case. The server MUST respond with the same HTTP status code if the same URL is requested with HEAD and with GET. Example request for a domain name that is not available for provisioning: Accept-Language: en RPP-Cltrid: ABC-12345 ]]> Example response:

Resource Information The Object Info request MUST use the HTTP GET method on a resource identifying an object instance. If the object has authorization information attached then the client MUST use an empty message body and include the RPP-Authorization HTTP header. If the authorization is linked to a database object the client MUST also include the roid in the RPP-Authorization header. The client MAY also use a message body that includes the authorization information, the client MUST then not use the RPP-Authorization header.

Request: GET {collection}/{id}
Request message: Optional
Response message: Info response

Example request for an object not using authorization information. Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 ]]> Example request using RPP-Authorization header for an object that has attached authorization information. Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 RPP-Authorization: authinfo value=TXkgU2VjcmV0IFRva2Vu ]]> Example Info response:

Poll for Messages The messages endpoint is used for retrieving messages stored on the server for the client to process.

Request: GET /messages
Request message: None
Response message: Poll response

The client MUST use the HTTP GET method on the messages resource collection to request the message at the head of the queue. Example request: Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 ]]> Example response:

Delete Message

Request: DELETE /messages/{id}
Request message: None
Response message: Poll Ack response

The client MUST use the HTTP DELETE method to acknowledge receipt of a message from the queue. The "msgID" attribute of a received RPP Poll message MUST be included in the message resource URL, using the {id} path element. The server MUST use RPP headers to return the RPP result code and the number of messages left in the queue. The server MUST NOT add content to the HTTP message body of a successful response, the server may add content to the message body of an error response. Example request: Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 ]]> Example response:

Create Resource

Request: POST {collection}
Request message: Object Create request
Response message: Object Create response

The client MUST use the HTTP POST method to create a new object resource. If the RPP request results in a newly created object, then the server MUST return HTTP status code 200 (OK). The server MUST add the "Location" header to the response, the value of this header MUST be the URL for the newly created resource. Example Domain Create request: Accept: application/rpp+json Content-Type: application/rpp+json Accept-Language: en Content-Length: 220 TODO ]]> Example Domain Create response:

Delete Resource

Request: DELETE {collection}/{id}
Request message: Optional
Response message: Status

The client MUST the HTTP DELETE method and a resource identifying a unique object instance. The server MUST return HTTP status code 200 (OK) if the resource was deleted successfully. Example Domain Delete request: Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 ]]> Example Domain Delete response:

Processes Path Segment Each provisioning object may be related to one or more running processes, such as a transfer or deletion. Each process can have its own data, which is distinct from the data of the provisioning object itself. The processes can be started, stopped, or interacted with using their own specific set of representations and operations. All processes related to a provisioning object in RPP MUST exist under the /{collection}/{id}/processes/{process_name} path. The server operator MAY support direct access to process resources using server generated identifier. Such resource MAY be accessible using following URL: /{collection}/{id}/processes/{process_name}/{process_id}, where process_id is the process identifier. A process MAY also expose a resource at /{collection}/{id}/processes/{process_name}/latest to access and interact with the latest process instance. In case server offers any access to process information of given process name, the access to the last instance using /{collection}/{id}/processes/{process_name}/latest URL is MANDATORY. The server operator MAY decide which processes such resources exist for, whether they only exist for the currently running processes or also for completed or cancelled processes. The period for which completed processes remain available for retrieval is defined by server policy.

Generic proces interface A generic interface for interacting with the processes is defined as follows:

Starting: POST /{collection}/{id}/processes/{process_name} The payload of such a request contains process-specific input information. A started process MAY create a resource to access and interact with the process instance. In such case the response MUST be a 201 Created with a Location header pointing to the created resource together with the process state representation. The created resource can be made accessible both using the latest mnemonic under a URL /{collection}/{id}/processes/{process_name}/latest or using a process id under a URL /{collection}/{id}/processes/{process_name}/{process_id}. When a process is created, executed and immediately completed by the server, a 201 Created response MAY still be provided together with the representation of the process result. Server MAY decide not to expose any resource for interaction with the created process, in such case a 200 OK MUST be provided. Example:

Cancelling: A client MAY use the "latest" mnemonic to cancel the latest process instance, in such case the request MUST be: DELETE /{collection}/{id}/processes/{process_name}/latest If the client wants to cancel a specific process instance, the request MUST be: DELETE /{collection}/{id}/processes/{process_name}/{process_id} This request is intended to stop the running process. The server MUST return a 204 response if the process has been stopped and the resource is gone, or a 200 response if the process has been stopped but the resource remains.

Status A client MAY use the "latest" mnemonic to request the latest process instance, in such case the request MUST be: GET /{collection}/{id}/processes/{process_name}/latest If the client wants to retrieve data of a specific process instance, the request MUST be: GET /{collection}/{id}/processes/{process_name}/{process_id} The request retrieves the representation of the task status. If no task is running, the server MAY return the status of the completed task or return a 404 response.

Other operations Other operations on a process can be performed by adding path segments to the /{collection}/{id}/processes/{process_name}/latest or /{collection}/{id}/processes/{process_name}/{process_id} URL path.

Listing A server MAY implement a listing facility for some or all, current or past processes. The following URL structure and HTTP method MAY be exposed by the server and MUST be used by the client to retrieve process list filtered by process name: GET /{collection}/{id}/processes/{process_name}/ The following URL structure and HTTP method MAY be exposed by the server and MUST be used by the client to retrieve full process list independent of the process name: GET /{collection}/{id}/processes/ It is up to server policy to define the type of processes and state, running or completed, made available for the client. A server MAY also choose not implement this end point at all returning either the HTPP status code 404 Not Found or a 501 Not Implemented status code.

Relation to object representation In certain situations a resource creation may require additional process data or implicitly start an asynchronous process with own inputs, lifecycle and state. In these cases, the representation sent to the server MAY contain a combination of object data and process-related data. For example a domain create request contains domain representation data which will be stored with domain object, and domain creation process data such as registration duration or price, which would be part as registration process data, but not directly stored with the domain object. For the process data in the message body to be distinct and consistent with the URL path structure, it MUST be enclosed in the processes/{process_name} JSON path when transmitted with the object's representation. Structure: Example: Domain Create request with 2-year registration: Accept: application/rpp+json Content-Type: application/rpp+json Accept-Language: en Content-Length: 220 { "name": "foo.example", "processes": { "creation": { "periods": "P2Y" } } ... other domain data ... } ]]>

Renew Resource

Request: POST /{collection}/{id}/processes/renewals
Request message: Renew request
Response message: Renew response

Not every object resource includes support for the renew command. The response MUST include the Location header for the created renewal process resource. Example Domain Renew request: Accept: application/rpp+json Content-Type: application/rpp+json RPP-Cltrid: ABC-12345 Accept-Language: en Content-Length: 210 TODO: add renew request data here ]]> Example Renew response:

Transfer Resource The Transfer command is mapped to a nested resource, named "transfer". The semantics of the HTTP DELETE method are determined by the role of the client executing the DELETE method. The DELETE method is defined as "reject transfer" for the current sponsoring client of the object. For the new sponsoring client the DELETE method is defined as "cancel transfer".

Start

Request: POST /{collection}/{id}/processes/transfers
Request message: Optional
Response message: Status

In order to initiate a new object transfer process, the client MUST use the HTTP POST method on a unique resource to create a new transfer resource object. Not all RPP objects support the Transfer command. If the transfer request is successful, then the response MUST include the Location header for the object being transferred. Example request not using object authorization: Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 Content-Length: 0 ]]> Example request using object authorization: Accept: application/rpp+json RPP-Cltrid: ABC-12345 RPP-Authorization: authinfo value=TXkgU2VjcmV0IFRva2Vu Accept-Language: en Content-Length: 0 ]]> Example request using 1 year renewal period, using the unit and value query parameters: Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 Content-Length: 23 { "duration": "P2Y" } ]]> Example Transfer response:

Status A transfer object may not exist, when no transfer has been initiated for the specified object. The client MUST use the HTTP GET method and MUST NOT add content to the HTTP message body.

Request: GET {collection}/{id}/processes/transfers
Request message: Optional
Response message: Transfer Status response

Example domain name Transfer Status request without authorization information required: Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 ]]> If the requested transfer object has associated authorization information that is not linked to another database object, then the HTTP GET method MUST be used and the authorization information MUST be included using the RPP-Authorization header. Example domain name Transfer Query request using RPP-Authorization header: Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 RPP-Authorization: authinfo value=TXkgU2VjcmV0IFRva2Vu ]]> If the requested object has associated authorization information linked to another database object, then the HTTP GET method MUST be used and the RPP-Authorization header MUST be included. Example domain name Transfer Query request and authorization using RPP-Authorization header: Accept: application/rpp+json Accept-Language: en RPP-Authorization: authinfo value=TXkgU2VjcmV0IFRva2Vu Content-Length: 0 ]]> Example Transfer Query response:

Cancel

Request: POST /{collection}/{id}/processes/transfers/cancelation
Request message: Optional
Response message: Status

The new sponsoring client MUST use the HTTP POST method to cancel a requested transfer. Example request: Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 ]]> Example response:

Reject

Request: POST /{collection}/{id}/processes/transfers/rejection
Request message: None
Response message: Status

The currently sponsoring client of the object MUST use the HTTP POST method to reject a started transfer process. Example request: Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 ]]> Example Reject response:

Approve

Request: POST /{collection}/{id}/processes/transfers/approval
Request message: Optional
Response message: Status

The currently sponsoring client MUST use the HTTP POST method to approve a transfer requested by the new sponsoring client. Example Approve request: Accept: application/rpp+json Accept-Language: en RPP-Cltrid: ABC-12345 Content-Length: 0 ]]> Example Approve response:

Update Resource

Request: PATCH {collection}/{id}
Request message: Object Update message
Response message: Status

An object Update request MUST be performed using the HTTP PATCH method. The request message body MUST contain an Update message. TODO: when using JSON, also allow for JSON patch so client can send partial update data only? Example request: Accept: application/rpp+json Content-Type: application/rpp+json Accept-Language: en Content-Length: 252 TODO ]]> Example response:

Extension Framework TODO

RPP Result Codes RPP result codes are used to indicate the result of an RPP request. They are returned in the RPP-Code header of the HTTP response. The format of the RPP result code is a 5-digit string, where the first digit MUST always be "1", the second digit indicates the class of the result, and the remaining four digits indicate the specific result within that class, his allows implementers to define more specific result codes within each class. The classes of RPP result codes are designed to match the classes of HTTP status codes, to facilitate mapping between RPP result codes and HTTP status codes. The classes of RPP result codes are defined as follows:

11xxx: Informational
12xxx: Success
13xxx: Reserved for future use
14xxx: Client error
15xxx: Server error

The following RPP result codes are defined and used in this document:

RPP Result Code	HTTP Status Code	Description
12000	200 OK	Command completed successfully
12001	201 Created	Command completed successfully and a new resource was created

Authentication and Authorization Due to the stateless nature of RPP, the client MUST include the authentication credentials in each HTTP request. This MAY be done by using JSON Web Tokens (JWT) or Basic authentication . The server MUST validate the authentication credentials on each request and reject any request with invalid credentials with an appropriate HTTP status code. When using JWTs for OAuth 2.0 Access Tokens, the JWT profile described in MUST be used. It is RECOMMENDED to use short-lived tokens and to implement token revocation mechanisms to mitigate the risk of token compromise. If sensitive information is included in the JWT payload, it MUST be encrypted to prevent unauthorized access when the token is persistent to a storage device. Furthermore, the best practices for JWT usage as outlined in MUST be followed.

IANA Considerations

URN Sub-namespace for RPP (urn:ietf:params:rpp) The IANA is requested to add the following value to the "IETF URN Sub-namespace for Registered Protocol Parameter Identifiers" registry, following the template in : TODO: add filled in template, if we decide to use URN for profile identification, for example "urn:ietf:params:rpp:profile:example-profile"

RPP registry group The IANA is requested to create a new registry group for RPP, this will be used to group together all the RPP-related registries such as those for discovery URLs, extensions and profiles.

RPP Discovery registry The IANA is requested to create a new registry for RPP discovery URLs, this registry will be used to register the well-known URLs for RPP discovery endpoints, used by RPP clients to discover the capabilities of a RPP server. Fields to be registered:

tld: The top-level domain (TLD) for which the discovery URL is applicable, for example "example".
url: The URL for the discovery endpoint, for example "https://rpp.example/.well-known/rpp".
description: A human-readable description of the discovery URL and its intended use.

RPP Extension registry The IANA is requested to create a new registry for RPP extensions, this registry will be used to register standardized extensions to the RPP protocol. Extensions are defined as additional features or capabilities that can be added to the base RPP protocol, for example support for additional resource types, additional operations or additional authentication methods. Fields to be registered:

name: The name of the extension, for example "RPP example extension".
version: The version of the extension, for example "1.0".
url: The URL for the extension specification, for example "https://www.iana.org/assignments/rpp-extensions/rpp-example-extension-1.0".
description: A human-readable description of the extension and its intended use.

RPP Profile registry The IANA is requested to create a new registry for RPP profiles, this registry will be used to register standardized profiles for the RPP protocol. Profiles are defined as specific configurations of the RPP protocol that are designed to meet the needs of specific use cases or environments, for example an EPP compatibility profile that defines a set of RPP features and behaviors that are compatible with the Extensible Provisioning Protocol (EPP) . Fields to be registered:

name: The name of the profile, for example "EPP compatibility profile".
id: A unique URN identifier for the profile, for example "urn:ietf:params:rpp:profile:epp-compatibility-1.0".
version: The version of the profile, for example "1.0".
url: The URL for the profile specification, for example "https://www.iana.org/assignments/rpp-profiles/epp-compatibility-provisioning-profile-1.0".
description: A human-readable description of the profile and its intended use.

RPP Result Codes Registry The IANA is requested to create a new registry "RPP Result codes", this registry will be used to register RPP result codes defined in this document and in future RPP specifications and extensions. Fields to be registered:

code: The RPP result code, for example "12000".
description: A human-readable description of the result code and its intended use.

RPP Media Type (application/rpp+json) The IANA is requested to add the following RPP media type to the "Media Types" registry, following the template in :

Internationalization Considerations TODO

Security Considerations RPP relies on the security of the underlying HTTP transport, hence the best common practices for securing HTTP described in also apply to RPP and MUST be followed by RPP implementations. Data confidentiality and integrity MUST be enforced. Every client and server interaction MUST be encrypted using TLS version 1.3 . Future versions of TLS MAY be used as they become available and are deemed secure.

Change History

Version 04 to 05

Added Boostrap and Discovery sections to the document, describing how a client can discover the location and capabilities of an RPP server
Added IANA Considerations section with a request for new RPP discovery URLs, extensions and profile URLs.

Version 03 to 04

Added a new section on versioning, describing how versioning is applied to different RPP elements. (Issue #39)
Added IANA request for RPP Result codes registry, and added a table with example RPP result codes. (Issue #39)
Added IANA request for URN sub-namespace for RPP. (Issue #39)
Added a new "Profiles" section to describe how to define and use profiles. (Issue #43)
Added a new section "Authentication and Authorization". (Issue #37)
Updated the "Security Considerations" section to include transport security. (Issue #37)
Added IANA registration request for the new RPP media type. (Issue #40)

Version 02 to 03

Added use of Problem Detail for error responses

Version 01 to 02

Updated the examples, changed from ".example.org" to ".example"
Merged the RPP-EPP-Code and RPP-Code headers into a single RPP-Code header
Update the RPP-Authorization header to match the HTTP Authorization header format
Added new process path segment and process representations
Updated the Check request to now use an "availability" path segment and support both GET and HEAD methods

Version 00 to 01

Updated "Request Headers" and "Response Headers" section
Changed transfer resource URL and HTTP method for reject, approve and cancel, in order to make the API easier to use

Version 00 (draft-rpp-core) to 00 (draft-wullink-rpp-core)

Renamed the document name to "draft-wullink-rpp-core"
Removed sections: Design Considerations, Resource Naming Convention, Session Management, HTTP Layer, Content Negotiation, Object Filtering, Error Handling
Renamed Commands section to Endpoints
Removed text about extensions
Changed naming to be less EPP like and more RDAP like

Acknowledgements The authors would like to thank the following people for their helpful text contributions, comments and suggestions.

Q Misell, AS207960 Cyfyngedig