Last Updated: 1/7/2016 5:43:28 AM

/api/endpoint

GET ListEndpoints List the endpoints for the given site
http://demo.getrevelio.com/api/endpoint
List the endpoints for the given site
1/7/2016 5:43:31 AM

Query Parameters

List of endpoints
[
  • {
    • "createDate": "DateTime",
    • "info": {
      • "description": "String",
      • "isExcluded": "Boolean",
      • "metadata": {
        • "key1" : {},
        • "key2" : {}
        },
      • "method": "String",
      • "name": "String",
      • "parameters": [
        • {
          • "description": "String",
          • "examples": [
            • "String"
            ],
          • "isExcluded": "Boolean",
          • "isOptional": "Boolean",
          • "metadata": {
            • "key1" : {},
            • "key2" : {}
            },
          • "name": "String",
          • "source": "ParameterSource",
          • "type": {
            • "collectionType": (loop),
            • "description": "String",
            • "isCollection": "Boolean",
            • "isComplex": "Boolean",
            • "isDictionary": "Boolean",
            • "isExcluded": "Boolean",
            • "metadata": {
              • "key1" : {},
              • "key2" : {}
              },
            • "name": "String",
            • "properties": [
              • {
                • "description": "String",
                • "examples": [
                  • "String"
                  ],
                • "isExcluded": "Boolean",
                • "isOptional": "Boolean",
                • "metadata": {
                  • "key1" : {},
                  • "key2" : {}
                  },
                • "name": "String",
                • "type": (loop)
                }
              ]
            }
          }
        ],
      • "responses": [
        • {
          • "code": "Int32",
          • "description": "String",
          • "type": {
            • "collectionType": (loop),
            • "description": "String",
            • "isCollection": "Boolean",
            • "isComplex": "Boolean",
            • "isDictionary": "Boolean",
            • "isExcluded": "Boolean",
            • "metadata": {
              • "key1" : {},
              • "key2" : {}
              },
            • "name": "String",
            • "properties": [
              • {
                • "description": "String",
                • "examples": [
                  • "String"
                  ],
                • "isExcluded": "Boolean",
                • "isOptional": "Boolean",
                • "metadata": {
                  • "key1" : {},
                  • "key2" : {}
                  },
                • "name": "String",
                • "type": (loop)
                }
              ]
            }
          }
        ],
      • "route": "String",
      • "tags": [
        • "String"
        ]
      }
    }
]
Site does not exist
"String"

PUT SetEndpoint Sets the endpoint information for the given site
http://demo.getrevelio.com/api/endpoint
Sets the endpoint information for the given site
1/7/2016 5:03:17 AM

Request Body

{
  • "description": "String",
  • "metadata": {
    • "key1" : {},
    • "key2" : {}
    },
  • "method" : "String",
  • "name": "String",
  • "parameters": [
    • {
      • "description": "String",
      • "examples": [
        • "String"
        ],
      • "isExcluded": "Boolean",
      • "isOptional": "Boolean",
      • "metadata": {
        • "key1" : {},
        • "key2" : {}
        },
      • "name": "String",
      • "source": "ParameterSource",
      • "type": {
        • "collectionType": (loop),
        • "description": "String",
        • "isCollection": "Boolean",
        • "isComplex": "Boolean",
        • "isDictionary": "Boolean",
        • "isExcluded": "Boolean",
        • "metadata": {
          • "key1" : {},
          • "key2" : {}
          },
        • "name": "String",
        • "properties": [
          • {
            • "description": "String",
            • "examples": [
              • "String"
              ],
            • "isExcluded": "Boolean",
            • "isOptional": "Boolean",
            • "metadata": {
              • "key1" : {},
              • "key2" : {}
              },
            • "name": "String",
            • "type": (loop)
            }
          ]
        }
      }
    ],
  • "responses": [
    • {
      • "code": "Int32",
      • "description": "String",
      • "type": {
        • "collectionType": (loop),
        • "description": "String",
        • "isCollection": "Boolean",
        • "isComplex": "Boolean",
        • "isDictionary": "Boolean",
        • "isExcluded": "Boolean",
        • "metadata": {
          • "key1" : {},
          • "key2" : {}
          },
        • "name": "String",
        • "properties": [
          • {
            • "description": "String",
            • "examples": [
              • "String"
              ],
            • "isExcluded": "Boolean",
            • "isOptional": "Boolean",
            • "metadata": {
              • "key1" : {},
              • "key2" : {}
              },
            • "name": "String",
            • "type": (loop)
            }
          ]
        }
      }
    ],
  • "revision": "String",
  • "route" : "String",
  • "sitePath": "String",
  • "tags": [
    • "String"
    ]
}
Success
{}
Invalid data
"String"
Site or revision were not found
"String"

/api/license

GET GetLicenseInfoAsync Retrieves license information
http://demo.getrevelio.com/api/license
Retrieves license information
1/7/2016 5:43:31 AM
License information
{
  • "body": {
    • "email": "String",
    • "licenseKey": "String"
    },
  • "errors": [
    • "String"
    ],
  • "status": "Status"
}

PUT SetLicenseInfoAsync Sets license information
http://demo.getrevelio.com/api/license
Sets license information
1/7/2016 5:43:31 AM

Request Body

{
  • "email": "String",
  • "licenseKey": "String"
}
License info successfully set
"String"
License info is incorrect
"String"

/api/site

POST CreateSite Creates a new site, or a new revision if the site already exists
http://demo.getrevelio.com/api/site
Creates a new site, or a new revision if the site already exists
1/7/2016 5:03:17 AM

Request Body

{
}
Success
{
}
Invalid data
"String"

GET ListSites
http://demo.getrevelio.com/api/site
1/7/2016 5:43:29 AM

Query Parameters

  • startsWith String
Success
[
  • {
    • "generatedDate": "DateTime",
    • "isActive": "Boolean",
    • "path": "String",
    • "revision": "String",
    • "url": "String"
    }
]

PUT UpdateSite Updates the given site and revision
http://demo.getrevelio.com/api/site
Updates the given site and revision
1/7/2016 5:03:17 AM

Request Body

{
  • "isActive" : "Boolean",
  • "path": "String",
  • "revision": "String",
  • "url" : "String"
}
Success
{}
Invalid data
"String"
Site or revision were not found
"String"

/api/site/{*sitepath}

GET GetSite Retrieve the site with the given path
http://demo.getrevelio.com/api/site/{*sitePath}
Retrieve the site with the given path
1/7/2016 5:43:30 AM

Route Parameters

Site information
{
  • "generatedDate": "DateTime",
  • "isActive": "Boolean",
  • "path": "String",
  • "revision": "String",
  • "url": "String"
}
Site does not exist
"String"

/api/version

GET GetRevelioVersion Returns the version of Revelio
http://demo.getrevelio.com/api/version
Returns the version of Revelio
1/7/2016 5:43:31 AM
Version string
"String"

/stub

POST Create Creates a new stub site
http://demo.getrevelio.com/stub
Creates a new stub site
1/7/2016 5:43:32 AM

Request Body

{
}
Success
{
  • "key": "String"
}
Record already exists
"String"

/stub/{*sitepath}

GET List Lists the stubs available for the given site
http://demo.getrevelio.com/stub/{*sitePath}
Lists the stubs available for the given site
1/7/2016 5:03:20 AM

Route Parameters

List of stubs
{
  • "body": [
    • {
      • "description": "String",
      • "key": "String",
      • "name": "String",
      • "sitePath": "String",
      • "url": "String",
      • "urlAction": "UrlAction"
      }
    ],
  • "errors": [
    • "String"
    ],
  • "status": "Status"
}

/stub/{sitename}/{*path}

PUT SetStubEndpoint Sets the response for the requested path in siteName
http://demo.getrevelio.com/stub/{siteName}/{*path}
Sets the response for the requested path in siteName
1/7/2016 5:43:32 AM

Route Parameters

Request Body

{
  • "content": "String",
  • "httpMethod": "String",
  • "mediaType": "String",
  • "responseCode": "Int32"
}
Success
{}
Invalid request data
"String"
Stub does not exist
"String"

/stubsite/{sitename}/{*path}

GET GetStubResponse
http://demo.getrevelio.com/stubsite/{siteName}/{*path}
1/7/2016 5:03:20 AM

Route Parameters

Returns the response code and content as specified for this stub
No response specified