Contents x
    v1 Pull and acknowledge messages from a queue
    • 26 Mar 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    v1 Pull and acknowledge messages from a queue

    • Updated on 26 Mar 2024
    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /v1/tenants/{tenantId}/projects/{projectId}/subscriptions/{sub}:pull

    Pull and acknowledge messages from a queue

    Security
    API Key
    Header parameter nameAuthorization

    AWS Cognito Authorizer. Since there are no custom scopes the ID Token must be used for authorization

    Path parameters
    tenantId
    stringRequired

    The RapidIdentity Cloud tenant id

    projectId
    stringRequired

    The project id this service belongs. MUST be builtin or custom

    sub
    stringRequired

    The queue name.

    Body parameters

    The number of messages to pull from the queue.

    maxMessagesExample

    Retrieving up to 5 messages from queue

    {
  "maxMessages": 5
}
    object
    maxMessages
    integer Required

    The maximum number of messages to return from this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified

    Responses
    200

    An array of messages from the queue or nil

    Expand All
    OneOf
    PullSuccessBody
    receivedMessages
    Array of object (PubsubMessageV1)
    object
    data
    string
    messageId
    string
    publishTime
    string
    SuccessBody
    success
    string
    PullLogSuccessBody
    receivedMessages
    Array of object
    object
    400

    Body is not present or formatted incorrectly

    object
    error
    string
    403

    The request is not authorized. Check that an api key exists and that the api key is valid for the tenantId

    object
    error
    string
    500

    Unable to retrieve queue as name does not exist

    object
    error
    string
    501

    The request does not have a projectId of custom or builtin

    object
    error
    string
    503

    Unable to connect to pubsub service

    object
    error
    string
    Was this article helpful?
    What's Next