Skip to main content

Create an Api Discovery Endpoint for the given organisation and Authorisation Server and Api Version

POST 
/organisations/:OrganisationId/authorisationservers/:AuthorisationServerId/apiresources/:ApiResourceId/apidiscoveryendpoints

adds a new api discovery endpoint to an existing api resource

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    The organisation ID

    AuthorisationServerId AuthorisationServerIdrequired

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The authorisation server Id

    ApiResourceId ApiResourceIdrequired

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The api version Id

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

    The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

    x-fapi-customer-ip-address string

    The PSU's IP address if the PSU is currently logged in with the TPP.

    x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    x-customer-user-agent string

    Indicates the user-agent that the PSU is using.

Body

Api Resource request

    ApiEndpoints

    object[]

    required

  • Array [

    • ApiEndpoint ApiEndpoint (string)required

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

  • ]

Responses​

Api endpoint creation response with family complete flag

Response Headers

  • x-fapi-interaction-id

    string

Schema

    ApiDiscoveryEndpoints

    object[]

  • Array [

    • ApiDiscoveryId ApiEndpointId (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The unique ID of an Api discovery endpoint resource

    ApiEndpoint ApiEndpoint (string)

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

  • ]

    • FamilyComplete boolean

    Denotes a completed api family set

Loading...