Endpoints

Resource URI

/services/{serviceId}/endpoints/{endpointId}

Items in curly braces represent variables.

Description

An endpoint object describes a specific addressable resource within the proxy service.

Note: For details on token endpoint creation using V3 API call, see the POST Create Token Endpoint topic.

Resource Schema

Property	Characteristics
id	Type	string
	Sub-type
	Create Rule	Ignored
	Update Rule	Required (if not in context)
	Fetch Rule	Implicit
	Description	Object identifier (External endpoint identifier).
allowMissingApiKey	Type	boolean
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Set to true to allow calls without API keys. This property is for the calls made to Mashery. This property requires that a special API key is created with the key value of noapikey. This key is used by Mashery to accept the API call, apply the business rules, and log requests for the endpoint.
apiKeyValueLocationKey	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Enter the API Key ID. This can either be the name field that designates the key in your API calls or, in the case of a Key Location of Path, a space delimited set of numbers designating the locations in the request path that should be recorded as the API key. The key location identifier helps Mashery to identify the key in the key source.
apiKeyValueLocations	Type	array
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	enum literals: request-parameters, request-path, request-body, request-header, custom
apiMethodDetectionKey	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Enter the method identifier, aka the string that uniquely identifies the incoming method to the Traffic Manager. It defines where to look for a method in a request path. The method location identifier helps Mashery to identify the method in the method source.
apiMethodDetectionLocations	Type	array
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	enum literals: request-parameters, request-path, request-body, request-header, custom
cache	Type	object
	Sub-type	Cache
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Cache object. Set of properties managing the cache behaviors for the Endpoint.
connectionTimeoutForSystemDomainRequest	Type	integer
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	enum literals: 2,5,10,20,30,45,60
connectionTimeoutForSystemDomainResponse	Type	integer
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	enum literals: 2,5,10,20,30,45,60,120,300,600,900,1200
cookiesDuringHttpRedirectsEnabled	Type	boolean
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Set to true to enable cookies during redirects. Cookies can be enabled and collected during server requests from Mashery to the client API server.
cors	Type	object
	Sub-type	Cors
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Cors object. Set of properties managing the CORS behaviors for the Endpoint.
created	Type	string
	Sub-type	datetime
	Create Rule	Ignored
	Update Rule	Ignored
	Fetch Rule	Implicit
	Description	Date/time the object was created.
customRequestAuthenticationAdapter	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Custom adapter for authentication for an endpoint
dropApiKeyFromIncomingCall	Type	boolean
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Drop mapi from call
forceGzipOfBackendCall	Type	boolean
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Force GZip Accept-Encoding on backend call
gzipPassthroughSupportEnabled	Type	boolean
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Set to true to enable GZIP passthrough. Traffic Manager accepts and sends GZip directives to the client API server.
headersToExcludeFromIncomingCall	Type	array
	Sub-type	string
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	HTTP Headers to Drop from Incoming Call
highSecurity	Type	boolean
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Set to true if calls made to this Endpoint should always be under SSL. Enable this for greater security of the API calls made against this Endpoint. NOTE: your customer area must be configured for this feature.
hostPassthroughIncludedInBackendCallHeader	Type	boolean
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Pass X-Mashery-Host Header in Request
inboundSslRequired	Type	boolean
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	value in db will be 0 for false and 1 for true
jsonpCallbackParameter	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	The parameter is used by Traffic Manager while handling the JSON responses.
jsonpCallbackParameterValue	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	The default parameter value can be set to be used by Traffic Manager to effectively handle the JSON response.
scheduledMaintenanceEvent	Type	object
	Sub-type	ScheduledMaintenanceEvent
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Scheduled Maintenance Event object.
forwardedHeaders	Type	array
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	enum literals: mashery-host, mashery-message-id, mashery-service-id
returnedHeaders	Type	array
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	enum literals: mashery-message-id, mashery-responder
methods	Type	array
	Sub-type	Method
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Methods that belong to the Endpoint.
name	Type	string
	Sub-type
	Create Rule	Required
	Update Rule	Optional
	Fetch Rule	Implicit
	Description	Endpoint name.
numberOfHttpRedirectsToFollow	Type	integer
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Enter a number of HTTP redirects to follow. By default, Traffic Manager does not handle any redirects.
outboundRequestTargetPath	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Request path
outboundRequestTargetQueryParameters	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Outbound query parameters
outboundTransportProtocol	Type	string
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	enum literals: use-inbound, http, https
processor	Type	object
	Sub-type	Processor
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Processor object. This is a set of properties uses to manage customizations to API call traffic management.
publicDomains	Type	array
	Sub-type	Domain
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	The public hostname (domain name) is used by a developer application or widget to make an API call.
requestAuthenticationType	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Authentication type for the endpoint
requestPathAlias	Type	string
	Sub-type
	Create Rule	Required
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Request path
requestProtocol	Type	string
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	enum literals: rest,soap,xml-rpc,json-rpc,other
oauthGrantTypes	Type	array
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	enum literals: authorization-code, implicit, password, client-credentials
supportedHttpMethods	Type	array
	Sub-type	enum
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	enum literals: get, post, put, delete, head, options, patch
systemDomainAuthentication	Type	object
	Sub-type	SystemDomainAuthentication
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	SystemDomainAuthentication object.
systemDomains	Type	array
	Sub-type	Domain
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	The domain name of the client API server. Mashery performs call logging, and applies the business rules before sending an API call to this domain.
trafficManagerDomain	Type	string
	Sub-type
	Create Rule	Required
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	The Traffic Manager internal hostname (domain name) to which the requested public hostname is CNAMED. You must consult Mashery before creating new Mashery internal hostnames.
updated	Type	string
	Sub-type	datetime
	Create Rule	Ignored
	Update Rule	Ignored
	Fetch Rule	Implicit
	Description	Date/time the object was last updated.
useSystemDomainCredentials	Type	boolean
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	To suit to the client server's requirement, Mashery can swap the API credentials such as API keys and send the swapped Mashery credentials to the client API server.
systemDomainCredentialKey	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Key to use when making call to the client API server.
systemDomainCredentialSecret	Type	string
	Sub-type
	Create Rule	Optional
	Update Rule	Optional
	Fetch Rule	Explicit
	Description	Secret to use when making call to the client API server.

fetch all [GET]

Retrieves collection of Endpoints in the identified Service Definition, returning an Array of Service Definition Endpoints

Parameters

Parameter	Required	Type	Description
serviceId	true	string	Service identifier.
fields	false	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter	false	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort	false	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\\|desc)\]>\[,...\]\[&sort=...\]
limit	false	int	Number of objects to return in the result. Defaults to 100.
offset	false	int	0-based index of first object in the list to return. Defaults to 0.

Returns

Success

Array of ServiceDefinitionEndpoints for the Service If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "requestProtocol": "xml-rpc",
        "trafficManagerDomain": "powermens.ru",
        "supportedHttpMethods": "patch",
        "numberOfHttpRedirectsToFollow": 78,
        "requestAuthenticationType": "commodo vulputate justo",
        "requestPathAlias": "quam suspendisse potenti",
        "useSystemDomainCredentials": false,
        "outboundRequestTargetPath": "nulla ultrices aliquet maecenas",
        "apiMethodDetectionLocations": "request-parameters",
        "id": "c77dd3dc-53fa-4a50-9d04-d29af63127f7",
        "apiMethodDetectionKey": "suspendisse potenti cras",
        "cookiesDuringHttpRedirectsEnabled": false,
        "forwardedHeaders": "mashery-host",
        "updated": "2014-05-28T17:32:53.000+0000",
        "created": "2014-05-22T15:44:28.000+0000",
        "gzipPassthroughSupportEnabled": true,
        "inboundSslRequired": true,
        "name": "suspendisse potenti cras",
        "apiKeyValueLocations": "custom",
        "customRequestAuthenticationAdapter": "quam suspendisse",
        "systemDomainCredentialSecret": "donec",
        "oauthGrantTypes": "client-credentials",
        "allowMissingApiKey": false,
        "dropApiKeyFromIncomingCall": false,
        "outboundRequestTargetQueryParameters": "fusce consequat",
        "systemDomainCredentialKey": "metus",
        "highSecurity": false,
        "forceGzipOfBackendCall": true,
        "connectionTimeoutForSystemDomainResponse": 93,
        "apiKeyValueLocationKey": "pellentesque",
        "jsonpCallbackParameterValue": "ut",
        "jsonpCallbackParameter": "libero",
        "connectionTimeoutForSystemDomainRequest": 8,
        "returnedHeaders": "mashery-responder",
        "hostPassthroughIncludedInBackendCallHeader": true,
        "outboundTransportProtocol": "use-inbound"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "id": "f29128a1-52bb-4bb7-b936-bac25ec5ab65",
        "created": "2014-02-27T16:50:52.000+0000",
        "updated": "2013-10-01T15:38:21.000+0000",
        "name": "accumsan tellus nisi"
    }
]

fetch [GET]

Retrieves the identified Endpoint, returning a Service Definition Endpoint

Parameters

Parameter	Required	Type	Description
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.
fields	false	string	Comma-separated list of property paths to include in response. Each property path is a dot-separated list of object property names. fields=<property\[.property...\]>\[,...\]\[&fields=...\]
filter	false	string	Colon-separated name/value pair specifying the name of property whose value must contain the given value (as a substring). Results may also be filtered by nested collections' properties by specifying a dot-separated property path. filter=<property\[.property...\]>:<value>\[&filter=...\]
sort	false	string	Comma-separated list of properties to sort by. Only root-level properties are supported. Each property name may be optionally followed by :asc or :desc to specify sort direction (defaults to asc). sort=<property\[:(asc\\|desc)\]>\[,...\]\[&sort=...\]
limit	false	int	Number of objects to return in the result. Defaults to 100.
offset	false	int	0-based index of first object in the list to return. Defaults to 0.
indent	false	boolean	When set to true, responses are indented for better readability.

Returns

Success

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "requestProtocol": "rest",
        "trafficManagerDomain": "silver-performance.de",
        "supportedHttpMethods": "delete",
        "numberOfHttpRedirectsToFollow": 96,
        "requestAuthenticationType": "donec odio justo sollicitudin",
        "requestPathAlias": "sapien non",
        "useSystemDomainCredentials": false,
        "outboundRequestTargetPath": "rutrum neque aenean",
        "apiMethodDetectionLocations": "request-path",
        "id": "eccd517d-b1ba-4ae0-b319-7efab2b5e268",
        "apiMethodDetectionKey": "consequat ut nulla sed",
        "cookiesDuringHttpRedirectsEnabled": false,
        "forwardedHeaders": "mashery-host",
        "updated": "2013-10-12T00:44:28.000+0000",
        "created": "2014-06-30T07:30:44.000+0000",
        "gzipPassthroughSupportEnabled": false,
        "inboundSslRequired": false,
        "name": "vulputate vitae",
        "apiKeyValueLocations": "request-path",
        "customRequestAuthenticationAdapter": "curabitur convallis",
        "systemDomainCredentialSecret": "et ultrices posuere",
        "oauthGrantTypes": "implicit",
        "allowMissingApiKey": true,
        "dropApiKeyFromIncomingCall": true,
        "outboundRequestTargetQueryParameters": "pede",
        "systemDomainCredentialKey": "curabitur in libero ut",
        "highSecurity": false,
        "forceGzipOfBackendCall": true,
        "connectionTimeoutForSystemDomainResponse": 61,
        "apiKeyValueLocationKey": "velit id",
        "jsonpCallbackParameterValue": "ligula suspendisse",
        "jsonpCallbackParameter": "ridiculus mus vivamus",
        "connectionTimeoutForSystemDomainRequest": 84,
        "returnedHeaders": "mashery-responder",
        "hostPassthroughIncludedInBackendCallHeader": false,
        "outboundTransportProtocol": "http"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json"

Response

[
    {
        "id": "ba82c6f6-2bc2-4cb0-8272-bcb7ec67486b",
        "created": "2014-03-05T22:01:57.000+0000",
        "updated": "2014-06-30T14:16:28.000+0000",
        "name": "dictumst maecenas"
    }
]

create [POST]

Creates a new Endpoint in the given Service Definition.

Parameters

Parameter	Required	Type	Description
serviceId	true	string	Service identifier.
endpoint	true	object	ServiceDefinitionEndpoint object

Returns

Success

ServiceDefinitionEndpoint as created If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"trafficManagerDomain":"slappyto.net","requestProtocol":"rest","supportedHttpMethods":"get","numberOfHttpRedirectsToFollow":100,"useSystemDomainCredentials":true,"requestPathAlias":"sed","requestAuthenticationType":"ligula suspendisse","apiMethodDetectionLocations":"request-header","outboundRequestTargetPath":"diam","apiMethodDetectionKey":"tellus","id":"9c2d8963-16f1-4dbc-bf69-0e786ca62f35","cookiesDuringHttpRedirectsEnabled":true,"forwardedHeaders":"mashery-message-id","updated":"2014-06-18T21:22:51.000+0000","created":"2014-01-05T18:06:47.000+0000","gzipPassthroughSupportEnabled":true,"inboundSslRequired":true,"name":"rutrum neque aenean","apiKeyValueLocations":"request-parameters","customRequestAuthenticationAdapter":"viverra pede ac","systemDomainCredentialSecret":"vestibulum","oauthGrantTypes":"implicit","allowMissingApiKey":true,"dropApiKeyFromIncomingCall":false,"systemDomainCredentialKey":"risus","outboundRequestTargetQueryParameters":"varius ut","highSecurity":true,"forceGzipOfBackendCall":false,"connectionTimeoutForSystemDomainResponse":26,"apiKeyValueLocationKey":"at nulla suspendisse potenti","connectionTimeoutForSystemDomainRequest":18,"jsonpCallbackParameter":"sociis","jsonpCallbackParameterValue":"justo in hac habitasse","returnedHeaders":"mashery-responder","hostPassthroughIncludedInBackendCallHeader":false,"outboundTransportProtocol":"http"}

Response

[
    {
        "requestProtocol": "rest",
        "trafficManagerDomain": "nnys.com",
        "supportedHttpMethods": "put",
        "numberOfHttpRedirectsToFollow": 12,
        "requestAuthenticationType": "dictumst morbi vestibulum velit",
        "requestPathAlias": "consequat in consequat ut",
        "useSystemDomainCredentials": false,
        "outboundRequestTargetPath": "cubilia",
        "apiMethodDetectionLocations": "request-parameters",
        "id": "afc814f6-647e-426c-aa48-f0a691ad9009",
        "apiMethodDetectionKey": "sed interdum venenatis turpis",
        "cookiesDuringHttpRedirectsEnabled": true,
        "forwardedHeaders": "mashery-service-id",
        "updated": "2014-04-26T21:54:16.000+0000",
        "created": "2014-04-14T02:22:22.000+0000",
        "gzipPassthroughSupportEnabled": true,
        "inboundSslRequired": true,
        "name": "posuere felis sed lacus",
        "apiKeyValueLocations": "request-body",
        "customRequestAuthenticationAdapter": "luctus et",
        "systemDomainCredentialSecret": "ipsum",
        "oauthGrantTypes": "implicit",
        "allowMissingApiKey": true,
        "dropApiKeyFromIncomingCall": true,
        "outboundRequestTargetQueryParameters": "nonummy integer non",
        "systemDomainCredentialKey": "consequat morbi",
        "highSecurity": true,
        "forceGzipOfBackendCall": true,
        "connectionTimeoutForSystemDomainResponse": 64,
        "apiKeyValueLocationKey": "aenean auctor",
        "jsonpCallbackParameterValue": "nisl nunc nisl",
        "jsonpCallbackParameter": "vestibulum sit amet cursus",
        "connectionTimeoutForSystemDomainRequest": 87,
        "returnedHeaders": "mashery-message-id",
        "hostPassthroughIncludedInBackendCallHeader": true,
        "outboundTransportProtocol": "use-inbound"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request POST --data '{"id":"b7c4b8b3-ff2f-4fe5-a61e-4ad29256a123","updated":"2014-05-10T13:31:17.000+0000","created":"2014-06-03T03:02:16.000+0000","name":"donec semper"}

Response

[
    {
        "id": "ca357df2-fe20-4166-af92-1ddbb3d58cfd",
        "created": "2014-01-24T12:42:30.000+0000",
        "updated": "2013-10-22T12:55:20.000+0000",
        "name": "quam suspendisse potenti"
    }
]

update [PUT]

Updates the identified Endpoint.

Parameters

Parameter	Required	Type	Description
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.
endpoint	true	object	ServiceDefinitionEndpoint object

Returns

Success

ServiceDefinitionEndpoint as persisted If fields request parameter is not included, only those fields with "Fetch Rule" equal to "Implicit" will be returned. Otherwise, the fields contained in the URL parameter will be included in the response.

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"trafficManagerDomain":"blowingwind.org","requestProtocol":"json-rpc","supportedHttpMethods":"delete","numberOfHttpRedirectsToFollow":11,"useSystemDomainCredentials":false,"requestPathAlias":"sociis natoque","requestAuthenticationType":"pellentesque volutpat","apiMethodDetectionLocations":"request-path","outboundRequestTargetPath":"fusce lacus purus aliquet","apiMethodDetectionKey":"justo morbi ut odio","id":"60f923c5-a1b9-4384-aef1-50f59f8b361a","cookiesDuringHttpRedirectsEnabled":true,"forwardedHeaders":"mashery-message-id","updated":"2014-05-06T23:21:40.000+0000","created":"2014-01-11T10:55:04.000+0000","gzipPassthroughSupportEnabled":false,"inboundSslRequired":false,"name":"tristique est et tempus","apiKeyValueLocations":"custom","customRequestAuthenticationAdapter":"viverra diam vitae quam","systemDomainCredentialSecret":"metus aenean fermentum","oauthGrantTypes":"client-credentials","allowMissingApiKey":false,"dropApiKeyFromIncomingCall":false,"systemDomainCredentialKey":"congue","outboundRequestTargetQueryParameters":"pretium nisl","highSecurity":false,"forceGzipOfBackendCall":false,"connectionTimeoutForSystemDomainResponse":80,"apiKeyValueLocationKey":"nam ultrices","connectionTimeoutForSystemDomainRequest":30,"jsonpCallbackParameter":"suspendisse ornare consequat lectus","jsonpCallbackParameterValue":"praesent lectus vestibulum quam","returnedHeaders":"mashery-responder","hostPassthroughIncludedInBackendCallHeader":false,"outboundTransportProtocol":"use-inbound"}

Response

[
    {
        "requestProtocol": "xml-rpc",
        "trafficManagerDomain": "getchute.com",
        "supportedHttpMethods": "head",
        "numberOfHttpRedirectsToFollow": 34,
        "requestAuthenticationType": "proin leo",
        "requestPathAlias": "cubilia curae nulla dapibus",
        "useSystemDomainCredentials": false,
        "outboundRequestTargetPath": "imperdiet sapien urna",
        "apiMethodDetectionLocations": "request-header",
        "id": "e365bffe-2f67-443b-a311-e94d7b0751b3",
        "apiMethodDetectionKey": "nascetur ridiculus mus",
        "cookiesDuringHttpRedirectsEnabled": false,
        "forwardedHeaders": "mashery-host",
        "updated": "2013-09-14T13:16:29.000+0000",
        "created": "2014-03-04T14:11:15.000+0000",
        "gzipPassthroughSupportEnabled": true,
        "inboundSslRequired": true,
        "name": "luctus nec molestie",
        "apiKeyValueLocations": "request-parameters",
        "customRequestAuthenticationAdapter": "sit",
        "systemDomainCredentialSecret": "donec quis orci eget",
        "oauthGrantTypes": "implicit",
        "allowMissingApiKey": false,
        "dropApiKeyFromIncomingCall": false,
        "outboundRequestTargetQueryParameters": "nibh",
        "systemDomainCredentialKey": "vitae ipsum aliquam",
        "highSecurity": false,
        "forceGzipOfBackendCall": true,
        "connectionTimeoutForSystemDomainResponse": 97,
        "apiKeyValueLocationKey": "duis bibendum morbi",
        "jsonpCallbackParameterValue": "vel enim sit",
        "jsonpCallbackParameter": "amet consectetuer adipiscing elit",
        "connectionTimeoutForSystemDomainRequest": 87,
        "returnedHeaders": "mashery-responder",
        "hostPassthroughIncludedInBackendCallHeader": true,
        "outboundTransportProtocol": "http"
    }
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request PUT --data '{"id":"6001598e-0cb2-46a0-8afd-22915237ba05","updated":"2014-06-15T16:47:20.000+0000","created":"2014-05-16T11:24:36.000+0000","name":"duis at"}

Response

[
    {
        "id": "4bce3c8c-0d01-4034-bde1-4c4a261945cd",
        "created": "2013-09-30T13:35:25.000+0000",
        "updated": "2014-01-12T09:13:43.000+0000",
        "name": "dui vel nisl duis"
    }
]

delete [DELETE]

Deletes the identified Endpoint.

Parameters

Parameter	Required	Type	Description
serviceId	true	string	Service identifier.
endpointId	true	string	Endpoint identifier.

Returns

Success

Empty response

Failure

Array of validation responses

Examples

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

Request

curl -k 'https://api.mashery.com/v3/rest/services/0fcc39d1c7ee470780e6cbe6/endpoints/0dd96770b82f4f248c4711d9' -H "Authorization: Bearer <insert your token here>" -H "Content-Type:application/json" --request DELETE

Response

[
    ""
]

version 8 as of 2 years ago by jpadre

Endpoints

Resource URI

Description

Resource Schema

fetch all [GET]

Parameters

Returns

Success

Failure

Examples

Request

Response

Request

Response

fetch [GET]

Parameters

Returns

Success

Failure

Examples

Request

Response

Request

Response

create [POST]

Parameters

Returns

Success

Failure

Examples

Request

Response

Request

Response

update [PUT]

Parameters

Returns

Success

Failure

Examples

Request

Response

Request

Response

delete [DELETE]

Parameters

Returns

Success

Failure

Examples

Request

Response

Request

Response

Docs Navigation